@objectstack/platform-objects 6.5.1 → 6.7.0

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.
@@ -30,11 +30,17 @@ declare const SETUP_APP: App;
30
30
  /**
31
31
  * System Overview Dashboard
32
32
  *
33
- * Provides at-a-glance monitoring of platform health and key metrics:
34
- * - Active user sessions
35
- * - Audit activity (recent events)
36
- * - Package installation status
37
- * - Platform configuration
33
+ * Unified sysadmin landing dashboard. Replaces the previous
34
+ * `system_overview` + `security_overview` split — the two dashboards
35
+ * had significant widget overlap (sys_audit_log pies, sys_session
36
+ * counts, recent-events tables) and the security cut did not justify
37
+ * a separate nav entry.
38
+ *
39
+ * Layout (4 rows on a 12-col grid):
40
+ * 1. Platform KPIs — users / orgs / sessions / packages
41
+ * 2. Security KPIs — login / permission / config audit counts
42
+ * 3. Distribution charts — audit events by action + by user
43
+ * 4. Recent audit events table
38
44
  */
39
45
  declare const SystemOverviewDashboard: {
40
46
  name: string;
@@ -87,6 +93,9 @@ declare const SystemOverviewDashboard: {
87
93
  type?: "table" | "bar" | "line" | "pie" | "area" | "scatter" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "stacked-area" | "step-line" | "spline" | "donut" | "funnel" | "pyramid" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot" | undefined;
88
94
  color?: string | undefined;
89
95
  stack?: string | undefined;
96
+ variant?: "primary" | "comparison" | undefined;
97
+ dashArray?: string | undefined;
98
+ opacity?: number | undefined;
90
99
  }[] | undefined;
91
100
  colors?: string[] | undefined;
92
101
  height?: number | undefined;
@@ -119,190 +128,11 @@ declare const SystemOverviewDashboard: {
119
128
  actionIcon?: string | undefined;
120
129
  object?: string | undefined;
121
130
  filter?: _objectstack_spec_data.FilterCondition | undefined;
122
- categoryField?: string | undefined;
123
- valueField?: string | undefined;
124
- measures?: {
125
- valueField: string;
126
- aggregate: "min" | "max" | "count" | "sum" | "avg";
127
- label?: string | undefined;
128
- format?: string | undefined;
129
- }[] | undefined;
130
- options?: unknown;
131
- responsive?: {
132
- breakpoint?: "md" | "xs" | "sm" | "lg" | "xl" | "2xl" | undefined;
133
- hiddenOn?: ("md" | "xs" | "sm" | "lg" | "xl" | "2xl")[] | undefined;
134
- columns?: {
135
- xs?: number | undefined;
136
- sm?: number | undefined;
137
- md?: number | undefined;
138
- lg?: number | undefined;
139
- xl?: number | undefined;
140
- '2xl'?: number | undefined;
141
- } | undefined;
142
- order?: {
143
- xs?: number | undefined;
144
- sm?: number | undefined;
145
- md?: number | undefined;
146
- lg?: number | undefined;
147
- xl?: number | undefined;
148
- '2xl'?: number | undefined;
149
- } | undefined;
150
- } | undefined;
151
- aria?: {
152
- ariaLabel?: string | undefined;
153
- ariaDescribedBy?: string | undefined;
154
- role?: string | undefined;
155
- } | undefined;
156
- }[];
157
- description?: string | undefined;
158
- header?: {
159
- showTitle: boolean;
160
- showDescription: boolean;
161
- actions?: {
162
- label: string;
163
- actionUrl: string;
164
- actionType?: "url" | "api" | "modal" | "flow" | "script" | undefined;
165
- icon?: string | undefined;
166
- }[] | undefined;
167
- } | undefined;
168
- columns?: number | undefined;
169
- gap?: number | undefined;
170
- refreshInterval?: number | undefined;
171
- dateRange?: {
172
- defaultRange: "custom" | "today" | "yesterday" | "this_week" | "last_week" | "this_month" | "last_month" | "this_quarter" | "last_quarter" | "this_year" | "last_year" | "last_7_days" | "last_30_days" | "last_90_days";
173
- allowCustomRange: boolean;
174
- field?: string | undefined;
175
- } | undefined;
176
- globalFilters?: {
177
- field: string;
178
- scope: "dashboard" | "widget";
179
- label?: string | undefined;
180
- type?: "number" | "date" | "text" | "select" | "lookup" | undefined;
181
- options?: {
182
- value: string | number | boolean;
183
- label: string;
184
- }[] | undefined;
185
- optionsFrom?: {
186
- object: string;
187
- valueField: string;
188
- labelField: string;
189
- filter?: _objectstack_spec_data.FilterCondition | undefined;
190
- } | undefined;
191
- defaultValue?: string | number | boolean | undefined;
192
- targetWidgets?: string[] | undefined;
193
- }[] | undefined;
194
- aria?: {
195
- ariaLabel?: string | undefined;
196
- ariaDescribedBy?: string | undefined;
197
- role?: string | undefined;
198
- } | undefined;
199
- performance?: {
200
- lazyLoad?: boolean | undefined;
201
- virtualScroll?: {
202
- enabled: boolean;
203
- itemHeight?: number | undefined;
204
- overscan?: number | undefined;
205
- } | undefined;
206
- cacheStrategy?: "none" | "cache-first" | "network-first" | "stale-while-revalidate" | undefined;
207
- prefetch?: boolean | undefined;
208
- pageSize?: number | undefined;
209
- debounceMs?: number | undefined;
210
- } | undefined;
211
- };
212
-
213
- /**
214
- * Security Overview Dashboard
215
- *
216
- * Provides security and compliance monitoring:
217
- * - User authentication events
218
- * - Permission changes
219
- * - System configuration audits
220
- * - Active user sessions
221
- */
222
- declare const SecurityOverviewDashboard: {
223
- name: string;
224
- label: string;
225
- widgets: {
226
- id: string;
227
- type: "table" | "bar" | "line" | "pie" | "area" | "scatter" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "stacked-area" | "step-line" | "spline" | "donut" | "funnel" | "pyramid" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot";
228
- aggregate: "min" | "max" | "count" | "sum" | "avg";
229
- layout: {
230
- x: number;
231
- y: number;
232
- w: number;
233
- h: number;
234
- };
235
- title?: string | undefined;
236
- description?: string | undefined;
237
- chartConfig?: {
238
- type: "table" | "bar" | "line" | "pie" | "area" | "scatter" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "stacked-area" | "step-line" | "spline" | "donut" | "funnel" | "pyramid" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot";
239
- showLegend: boolean;
240
- showDataLabels: boolean;
241
- title?: string | undefined;
242
- subtitle?: string | undefined;
243
- description?: string | undefined;
244
- xAxis?: {
245
- field: string;
246
- showGridLines: boolean;
247
- logarithmic: boolean;
248
- title?: string | undefined;
249
- format?: string | undefined;
250
- min?: number | undefined;
251
- max?: number | undefined;
252
- stepSize?: number | undefined;
253
- position?: "top" | "bottom" | "left" | "right" | undefined;
254
- } | undefined;
255
- yAxis?: {
256
- field: string;
257
- showGridLines: boolean;
258
- logarithmic: boolean;
259
- title?: string | undefined;
260
- format?: string | undefined;
261
- min?: number | undefined;
262
- max?: number | undefined;
263
- stepSize?: number | undefined;
264
- position?: "top" | "bottom" | "left" | "right" | undefined;
265
- }[] | undefined;
266
- series?: {
267
- name: string;
268
- yAxis: "left" | "right";
269
- label?: string | undefined;
270
- type?: "table" | "bar" | "line" | "pie" | "area" | "scatter" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "stacked-area" | "step-line" | "spline" | "donut" | "funnel" | "pyramid" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot" | undefined;
271
- color?: string | undefined;
272
- stack?: string | undefined;
273
- }[] | undefined;
274
- colors?: string[] | undefined;
275
- height?: number | undefined;
276
- annotations?: {
277
- type: "line" | "region";
278
- axis: "x" | "y";
279
- value: string | number;
280
- style: "solid" | "dashed" | "dotted";
281
- endValue?: string | number | undefined;
282
- color?: string | undefined;
283
- label?: string | undefined;
284
- }[] | undefined;
285
- interaction?: {
286
- tooltips: boolean;
287
- zoom: boolean;
288
- brush: boolean;
289
- clickAction?: string | undefined;
290
- } | undefined;
291
- aria?: {
292
- ariaLabel?: string | undefined;
293
- ariaDescribedBy?: string | undefined;
294
- role?: string | undefined;
295
- } | undefined;
131
+ compareTo?: "previousPeriod" | "previousYear" | {
132
+ offset: string;
296
133
  } | undefined;
297
- colorVariant?: "default" | "danger" | "success" | "warning" | "blue" | "teal" | "orange" | "purple" | undefined;
298
- requiresObject?: string | undefined;
299
- requiresService?: string | undefined;
300
- actionUrl?: string | undefined;
301
- actionType?: "url" | "api" | "modal" | "flow" | "script" | undefined;
302
- actionIcon?: string | undefined;
303
- object?: string | undefined;
304
- filter?: _objectstack_spec_data.FilterCondition | undefined;
305
134
  categoryField?: string | undefined;
135
+ categoryGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
306
136
  valueField?: string | undefined;
307
137
  measures?: {
308
138
  valueField: string;
@@ -420,7 +250,6 @@ declare const SetupAppTranslations: TranslationBundle;
420
250
  * - `apps.setup.label` / `description`
421
251
  * - `apps.setup.navigation.<id>.label` for every group AND leaf
422
252
  * - `dashboards.system_overview.*`
423
- * - `dashboards.security_overview.*`
424
253
  *
425
254
  * Object-level labels (Users, Roles, Audit Logs, …) are owned by the
426
255
  * sys_* object schemas themselves and translated separately.
@@ -442,4 +271,4 @@ declare const jaJP: TranslationData;
442
271
  */
443
272
  declare const esES: TranslationData;
444
273
 
445
- export { SETUP_APP, SecurityOverviewDashboard, SetupAppTranslations, SystemOverviewDashboard, en, esES, jaJP, zhCN };
274
+ export { SETUP_APP, SetupAppTranslations, SystemOverviewDashboard, en, esES, jaJP, zhCN };
@@ -30,11 +30,17 @@ declare const SETUP_APP: App;
30
30
  /**
31
31
  * System Overview Dashboard
32
32
  *
33
- * Provides at-a-glance monitoring of platform health and key metrics:
34
- * - Active user sessions
35
- * - Audit activity (recent events)
36
- * - Package installation status
37
- * - Platform configuration
33
+ * Unified sysadmin landing dashboard. Replaces the previous
34
+ * `system_overview` + `security_overview` split — the two dashboards
35
+ * had significant widget overlap (sys_audit_log pies, sys_session
36
+ * counts, recent-events tables) and the security cut did not justify
37
+ * a separate nav entry.
38
+ *
39
+ * Layout (4 rows on a 12-col grid):
40
+ * 1. Platform KPIs — users / orgs / sessions / packages
41
+ * 2. Security KPIs — login / permission / config audit counts
42
+ * 3. Distribution charts — audit events by action + by user
43
+ * 4. Recent audit events table
38
44
  */
39
45
  declare const SystemOverviewDashboard: {
40
46
  name: string;
@@ -87,6 +93,9 @@ declare const SystemOverviewDashboard: {
87
93
  type?: "table" | "bar" | "line" | "pie" | "area" | "scatter" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "stacked-area" | "step-line" | "spline" | "donut" | "funnel" | "pyramid" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot" | undefined;
88
94
  color?: string | undefined;
89
95
  stack?: string | undefined;
96
+ variant?: "primary" | "comparison" | undefined;
97
+ dashArray?: string | undefined;
98
+ opacity?: number | undefined;
90
99
  }[] | undefined;
91
100
  colors?: string[] | undefined;
92
101
  height?: number | undefined;
@@ -119,190 +128,11 @@ declare const SystemOverviewDashboard: {
119
128
  actionIcon?: string | undefined;
120
129
  object?: string | undefined;
121
130
  filter?: _objectstack_spec_data.FilterCondition | undefined;
122
- categoryField?: string | undefined;
123
- valueField?: string | undefined;
124
- measures?: {
125
- valueField: string;
126
- aggregate: "min" | "max" | "count" | "sum" | "avg";
127
- label?: string | undefined;
128
- format?: string | undefined;
129
- }[] | undefined;
130
- options?: unknown;
131
- responsive?: {
132
- breakpoint?: "md" | "xs" | "sm" | "lg" | "xl" | "2xl" | undefined;
133
- hiddenOn?: ("md" | "xs" | "sm" | "lg" | "xl" | "2xl")[] | undefined;
134
- columns?: {
135
- xs?: number | undefined;
136
- sm?: number | undefined;
137
- md?: number | undefined;
138
- lg?: number | undefined;
139
- xl?: number | undefined;
140
- '2xl'?: number | undefined;
141
- } | undefined;
142
- order?: {
143
- xs?: number | undefined;
144
- sm?: number | undefined;
145
- md?: number | undefined;
146
- lg?: number | undefined;
147
- xl?: number | undefined;
148
- '2xl'?: number | undefined;
149
- } | undefined;
150
- } | undefined;
151
- aria?: {
152
- ariaLabel?: string | undefined;
153
- ariaDescribedBy?: string | undefined;
154
- role?: string | undefined;
155
- } | undefined;
156
- }[];
157
- description?: string | undefined;
158
- header?: {
159
- showTitle: boolean;
160
- showDescription: boolean;
161
- actions?: {
162
- label: string;
163
- actionUrl: string;
164
- actionType?: "url" | "api" | "modal" | "flow" | "script" | undefined;
165
- icon?: string | undefined;
166
- }[] | undefined;
167
- } | undefined;
168
- columns?: number | undefined;
169
- gap?: number | undefined;
170
- refreshInterval?: number | undefined;
171
- dateRange?: {
172
- defaultRange: "custom" | "today" | "yesterday" | "this_week" | "last_week" | "this_month" | "last_month" | "this_quarter" | "last_quarter" | "this_year" | "last_year" | "last_7_days" | "last_30_days" | "last_90_days";
173
- allowCustomRange: boolean;
174
- field?: string | undefined;
175
- } | undefined;
176
- globalFilters?: {
177
- field: string;
178
- scope: "dashboard" | "widget";
179
- label?: string | undefined;
180
- type?: "number" | "date" | "text" | "select" | "lookup" | undefined;
181
- options?: {
182
- value: string | number | boolean;
183
- label: string;
184
- }[] | undefined;
185
- optionsFrom?: {
186
- object: string;
187
- valueField: string;
188
- labelField: string;
189
- filter?: _objectstack_spec_data.FilterCondition | undefined;
190
- } | undefined;
191
- defaultValue?: string | number | boolean | undefined;
192
- targetWidgets?: string[] | undefined;
193
- }[] | undefined;
194
- aria?: {
195
- ariaLabel?: string | undefined;
196
- ariaDescribedBy?: string | undefined;
197
- role?: string | undefined;
198
- } | undefined;
199
- performance?: {
200
- lazyLoad?: boolean | undefined;
201
- virtualScroll?: {
202
- enabled: boolean;
203
- itemHeight?: number | undefined;
204
- overscan?: number | undefined;
205
- } | undefined;
206
- cacheStrategy?: "none" | "cache-first" | "network-first" | "stale-while-revalidate" | undefined;
207
- prefetch?: boolean | undefined;
208
- pageSize?: number | undefined;
209
- debounceMs?: number | undefined;
210
- } | undefined;
211
- };
212
-
213
- /**
214
- * Security Overview Dashboard
215
- *
216
- * Provides security and compliance monitoring:
217
- * - User authentication events
218
- * - Permission changes
219
- * - System configuration audits
220
- * - Active user sessions
221
- */
222
- declare const SecurityOverviewDashboard: {
223
- name: string;
224
- label: string;
225
- widgets: {
226
- id: string;
227
- type: "table" | "bar" | "line" | "pie" | "area" | "scatter" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "stacked-area" | "step-line" | "spline" | "donut" | "funnel" | "pyramid" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot";
228
- aggregate: "min" | "max" | "count" | "sum" | "avg";
229
- layout: {
230
- x: number;
231
- y: number;
232
- w: number;
233
- h: number;
234
- };
235
- title?: string | undefined;
236
- description?: string | undefined;
237
- chartConfig?: {
238
- type: "table" | "bar" | "line" | "pie" | "area" | "scatter" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "stacked-area" | "step-line" | "spline" | "donut" | "funnel" | "pyramid" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot";
239
- showLegend: boolean;
240
- showDataLabels: boolean;
241
- title?: string | undefined;
242
- subtitle?: string | undefined;
243
- description?: string | undefined;
244
- xAxis?: {
245
- field: string;
246
- showGridLines: boolean;
247
- logarithmic: boolean;
248
- title?: string | undefined;
249
- format?: string | undefined;
250
- min?: number | undefined;
251
- max?: number | undefined;
252
- stepSize?: number | undefined;
253
- position?: "top" | "bottom" | "left" | "right" | undefined;
254
- } | undefined;
255
- yAxis?: {
256
- field: string;
257
- showGridLines: boolean;
258
- logarithmic: boolean;
259
- title?: string | undefined;
260
- format?: string | undefined;
261
- min?: number | undefined;
262
- max?: number | undefined;
263
- stepSize?: number | undefined;
264
- position?: "top" | "bottom" | "left" | "right" | undefined;
265
- }[] | undefined;
266
- series?: {
267
- name: string;
268
- yAxis: "left" | "right";
269
- label?: string | undefined;
270
- type?: "table" | "bar" | "line" | "pie" | "area" | "scatter" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "stacked-area" | "step-line" | "spline" | "donut" | "funnel" | "pyramid" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot" | undefined;
271
- color?: string | undefined;
272
- stack?: string | undefined;
273
- }[] | undefined;
274
- colors?: string[] | undefined;
275
- height?: number | undefined;
276
- annotations?: {
277
- type: "line" | "region";
278
- axis: "x" | "y";
279
- value: string | number;
280
- style: "solid" | "dashed" | "dotted";
281
- endValue?: string | number | undefined;
282
- color?: string | undefined;
283
- label?: string | undefined;
284
- }[] | undefined;
285
- interaction?: {
286
- tooltips: boolean;
287
- zoom: boolean;
288
- brush: boolean;
289
- clickAction?: string | undefined;
290
- } | undefined;
291
- aria?: {
292
- ariaLabel?: string | undefined;
293
- ariaDescribedBy?: string | undefined;
294
- role?: string | undefined;
295
- } | undefined;
131
+ compareTo?: "previousPeriod" | "previousYear" | {
132
+ offset: string;
296
133
  } | undefined;
297
- colorVariant?: "default" | "danger" | "success" | "warning" | "blue" | "teal" | "orange" | "purple" | undefined;
298
- requiresObject?: string | undefined;
299
- requiresService?: string | undefined;
300
- actionUrl?: string | undefined;
301
- actionType?: "url" | "api" | "modal" | "flow" | "script" | undefined;
302
- actionIcon?: string | undefined;
303
- object?: string | undefined;
304
- filter?: _objectstack_spec_data.FilterCondition | undefined;
305
134
  categoryField?: string | undefined;
135
+ categoryGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
306
136
  valueField?: string | undefined;
307
137
  measures?: {
308
138
  valueField: string;
@@ -420,7 +250,6 @@ declare const SetupAppTranslations: TranslationBundle;
420
250
  * - `apps.setup.label` / `description`
421
251
  * - `apps.setup.navigation.<id>.label` for every group AND leaf
422
252
  * - `dashboards.system_overview.*`
423
- * - `dashboards.security_overview.*`
424
253
  *
425
254
  * Object-level labels (Users, Roles, Audit Logs, …) are owned by the
426
255
  * sys_* object schemas themselves and translated separately.
@@ -442,4 +271,4 @@ declare const jaJP: TranslationData;
442
271
  */
443
272
  declare const esES: TranslationData;
444
273
 
445
- export { SETUP_APP, SecurityOverviewDashboard, SetupAppTranslations, SystemOverviewDashboard, en, esES, jaJP, zhCN };
274
+ export { SETUP_APP, SetupAppTranslations, SystemOverviewDashboard, en, esES, jaJP, zhCN };