@objectstack/platform-objects 6.6.0 → 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.
Files changed (13) hide show
  1. package/dist/apps/index.d.mts +12 -197
  2. package/dist/apps/index.d.ts +12 -197
  3. package/dist/apps/index.js +71 -270
  4. package/dist/apps/index.js.map +1 -1
  5. package/dist/apps/index.mjs +72 -270
  6. package/dist/apps/index.mjs.map +1 -1
  7. package/dist/index.d.mts +1 -1
  8. package/dist/index.d.ts +1 -1
  9. package/dist/index.js +71 -270
  10. package/dist/index.js.map +1 -1
  11. package/dist/index.mjs +72 -270
  12. package/dist/index.mjs.map +1 -1
  13. package/package.json +2 -2
package/dist/apps/index.d.mts CHANGED
@@ -30,203 +30,19 @@ 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
38
- */
39
- declare const SystemOverviewDashboard: {
40
- name: string;
41
- label: string;
42
- widgets: {
43
- id: string;
44
- 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";
45
- aggregate: "min" | "max" | "count" | "sum" | "avg";
46
- layout: {
47
- x: number;
48
- y: number;
49
- w: number;
50
- h: number;
51
- };
52
- title?: string | undefined;
53
- description?: string | undefined;
54
- chartConfig?: {
55
- 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";
56
- showLegend: boolean;
57
- showDataLabels: boolean;
58
- title?: string | undefined;
59
- subtitle?: string | undefined;
60
- description?: string | undefined;
61
- xAxis?: {
62
- field: string;
63
- showGridLines: boolean;
64
- logarithmic: boolean;
65
- title?: string | undefined;
66
- format?: string | undefined;
67
- min?: number | undefined;
68
- max?: number | undefined;
69
- stepSize?: number | undefined;
70
- position?: "top" | "bottom" | "left" | "right" | undefined;
71
- } | undefined;
72
- yAxis?: {
73
- field: string;
74
- showGridLines: boolean;
75
- logarithmic: boolean;
76
- title?: string | undefined;
77
- format?: string | undefined;
78
- min?: number | undefined;
79
- max?: number | undefined;
80
- stepSize?: number | undefined;
81
- position?: "top" | "bottom" | "left" | "right" | undefined;
82
- }[] | undefined;
83
- series?: {
84
- name: string;
85
- yAxis: "left" | "right";
86
- label?: string | undefined;
87
- 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
- color?: string | undefined;
89
- stack?: string | undefined;
90
- variant?: "primary" | "comparison" | undefined;
91
- dashArray?: string | undefined;
92
- opacity?: number | undefined;
93
- }[] | undefined;
94
- colors?: string[] | undefined;
95
- height?: number | undefined;
96
- annotations?: {
97
- type: "line" | "region";
98
- axis: "x" | "y";
99
- value: string | number;
100
- style: "solid" | "dashed" | "dotted";
101
- endValue?: string | number | undefined;
102
- color?: string | undefined;
103
- label?: string | undefined;
104
- }[] | undefined;
105
- interaction?: {
106
- tooltips: boolean;
107
- zoom: boolean;
108
- brush: boolean;
109
- clickAction?: string | undefined;
110
- } | undefined;
111
- aria?: {
112
- ariaLabel?: string | undefined;
113
- ariaDescribedBy?: string | undefined;
114
- role?: string | undefined;
115
- } | undefined;
116
- } | undefined;
117
- colorVariant?: "default" | "danger" | "success" | "warning" | "blue" | "teal" | "orange" | "purple" | undefined;
118
- requiresObject?: string | undefined;
119
- requiresService?: string | undefined;
120
- actionUrl?: string | undefined;
121
- actionType?: "url" | "api" | "modal" | "flow" | "script" | undefined;
122
- actionIcon?: string | undefined;
123
- object?: string | undefined;
124
- filter?: _objectstack_spec_data.FilterCondition | undefined;
125
- compareTo?: "previousPeriod" | "previousYear" | {
126
- offset: string;
127
- } | undefined;
128
- categoryField?: string | undefined;
129
- categoryGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
130
- valueField?: string | undefined;
131
- measures?: {
132
- valueField: string;
133
- aggregate: "min" | "max" | "count" | "sum" | "avg";
134
- label?: string | undefined;
135
- format?: string | undefined;
136
- }[] | undefined;
137
- options?: unknown;
138
- responsive?: {
139
- breakpoint?: "md" | "xs" | "sm" | "lg" | "xl" | "2xl" | undefined;
140
- hiddenOn?: ("md" | "xs" | "sm" | "lg" | "xl" | "2xl")[] | undefined;
141
- columns?: {
142
- xs?: number | undefined;
143
- sm?: number | undefined;
144
- md?: number | undefined;
145
- lg?: number | undefined;
146
- xl?: number | undefined;
147
- '2xl'?: number | undefined;
148
- } | undefined;
149
- order?: {
150
- xs?: number | undefined;
151
- sm?: number | undefined;
152
- md?: number | undefined;
153
- lg?: number | undefined;
154
- xl?: number | undefined;
155
- '2xl'?: number | undefined;
156
- } | undefined;
157
- } | undefined;
158
- aria?: {
159
- ariaLabel?: string | undefined;
160
- ariaDescribedBy?: string | undefined;
161
- role?: string | undefined;
162
- } | undefined;
163
- }[];
164
- description?: string | undefined;
165
- header?: {
166
- showTitle: boolean;
167
- showDescription: boolean;
168
- actions?: {
169
- label: string;
170
- actionUrl: string;
171
- actionType?: "url" | "api" | "modal" | "flow" | "script" | undefined;
172
- icon?: string | undefined;
173
- }[] | undefined;
174
- } | undefined;
175
- columns?: number | undefined;
176
- gap?: number | undefined;
177
- refreshInterval?: number | undefined;
178
- dateRange?: {
179
- 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";
180
- allowCustomRange: boolean;
181
- field?: string | undefined;
182
- } | undefined;
183
- globalFilters?: {
184
- field: string;
185
- scope: "dashboard" | "widget";
186
- label?: string | undefined;
187
- type?: "number" | "date" | "text" | "select" | "lookup" | undefined;
188
- options?: {
189
- value: string | number | boolean;
190
- label: string;
191
- }[] | undefined;
192
- optionsFrom?: {
193
- object: string;
194
- valueField: string;
195
- labelField: string;
196
- filter?: _objectstack_spec_data.FilterCondition | undefined;
197
- } | undefined;
198
- defaultValue?: string | number | boolean | undefined;
199
- targetWidgets?: string[] | undefined;
200
- }[] | undefined;
201
- aria?: {
202
- ariaLabel?: string | undefined;
203
- ariaDescribedBy?: string | undefined;
204
- role?: string | undefined;
205
- } | undefined;
206
- performance?: {
207
- lazyLoad?: boolean | undefined;
208
- virtualScroll?: {
209
- enabled: boolean;
210
- itemHeight?: number | undefined;
211
- overscan?: number | undefined;
212
- } | undefined;
213
- cacheStrategy?: "none" | "cache-first" | "network-first" | "stale-while-revalidate" | undefined;
214
- prefetch?: boolean | undefined;
215
- pageSize?: number | undefined;
216
- debounceMs?: number | undefined;
217
- } | undefined;
218
- };
219
-
220
- /**
221
- * Security Overview Dashboard
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.
222
38
  *
223
- * Provides security and compliance monitoring:
224
- * - User authentication events
225
- * - Permission changes
226
- * - System configuration audits
227
- * - Active user sessions
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
228
44
  */
229
- declare const SecurityOverviewDashboard: {
45
+ declare const SystemOverviewDashboard: {
230
46
  name: string;
231
47
  label: string;
232
48
  widgets: {
@@ -434,7 +250,6 @@ declare const SetupAppTranslations: TranslationBundle;
434
250
  * - `apps.setup.label` / `description`
435
251
  * - `apps.setup.navigation.<id>.label` for every group AND leaf
436
252
  * - `dashboards.system_overview.*`
437
- * - `dashboards.security_overview.*`
438
253
  *
439
254
  * Object-level labels (Users, Roles, Audit Logs, …) are owned by the
440
255
  * sys_* object schemas themselves and translated separately.
@@ -456,4 +271,4 @@ declare const jaJP: TranslationData;
456
271
  */
457
272
  declare const esES: TranslationData;
458
273
 
459
- export { SETUP_APP, SecurityOverviewDashboard, SetupAppTranslations, SystemOverviewDashboard, en, esES, jaJP, zhCN };
274
+ export { SETUP_APP, SetupAppTranslations, SystemOverviewDashboard, en, esES, jaJP, zhCN };
package/dist/apps/index.d.ts CHANGED
@@ -30,203 +30,19 @@ 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
38
- */
39
- declare const SystemOverviewDashboard: {
40
- name: string;
41
- label: string;
42
- widgets: {
43
- id: string;
44
- 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";
45
- aggregate: "min" | "max" | "count" | "sum" | "avg";
46
- layout: {
47
- x: number;
48
- y: number;
49
- w: number;
50
- h: number;
51
- };
52
- title?: string | undefined;
53
- description?: string | undefined;
54
- chartConfig?: {
55
- 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";
56
- showLegend: boolean;
57
- showDataLabels: boolean;
58
- title?: string | undefined;
59
- subtitle?: string | undefined;
60
- description?: string | undefined;
61
- xAxis?: {
62
- field: string;
63
- showGridLines: boolean;
64
- logarithmic: boolean;
65
- title?: string | undefined;
66
- format?: string | undefined;
67
- min?: number | undefined;
68
- max?: number | undefined;
69
- stepSize?: number | undefined;
70
- position?: "top" | "bottom" | "left" | "right" | undefined;
71
- } | undefined;
72
- yAxis?: {
73
- field: string;
74
- showGridLines: boolean;
75
- logarithmic: boolean;
76
- title?: string | undefined;
77
- format?: string | undefined;
78
- min?: number | undefined;
79
- max?: number | undefined;
80
- stepSize?: number | undefined;
81
- position?: "top" | "bottom" | "left" | "right" | undefined;
82
- }[] | undefined;
83
- series?: {
84
- name: string;
85
- yAxis: "left" | "right";
86
- label?: string | undefined;
87
- 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
- color?: string | undefined;
89
- stack?: string | undefined;
90
- variant?: "primary" | "comparison" | undefined;
91
- dashArray?: string | undefined;
92
- opacity?: number | undefined;
93
- }[] | undefined;
94
- colors?: string[] | undefined;
95
- height?: number | undefined;
96
- annotations?: {
97
- type: "line" | "region";
98
- axis: "x" | "y";
99
- value: string | number;
100
- style: "solid" | "dashed" | "dotted";
101
- endValue?: string | number | undefined;
102
- color?: string | undefined;
103
- label?: string | undefined;
104
- }[] | undefined;
105
- interaction?: {
106
- tooltips: boolean;
107
- zoom: boolean;
108
- brush: boolean;
109
- clickAction?: string | undefined;
110
- } | undefined;
111
- aria?: {
112
- ariaLabel?: string | undefined;
113
- ariaDescribedBy?: string | undefined;
114
- role?: string | undefined;
115
- } | undefined;
116
- } | undefined;
117
- colorVariant?: "default" | "danger" | "success" | "warning" | "blue" | "teal" | "orange" | "purple" | undefined;
118
- requiresObject?: string | undefined;
119
- requiresService?: string | undefined;
120
- actionUrl?: string | undefined;
121
- actionType?: "url" | "api" | "modal" | "flow" | "script" | undefined;
122
- actionIcon?: string | undefined;
123
- object?: string | undefined;
124
- filter?: _objectstack_spec_data.FilterCondition | undefined;
125
- compareTo?: "previousPeriod" | "previousYear" | {
126
- offset: string;
127
- } | undefined;
128
- categoryField?: string | undefined;
129
- categoryGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
130
- valueField?: string | undefined;
131
- measures?: {
132
- valueField: string;
133
- aggregate: "min" | "max" | "count" | "sum" | "avg";
134
- label?: string | undefined;
135
- format?: string | undefined;
136
- }[] | undefined;
137
- options?: unknown;
138
- responsive?: {
139
- breakpoint?: "md" | "xs" | "sm" | "lg" | "xl" | "2xl" | undefined;
140
- hiddenOn?: ("md" | "xs" | "sm" | "lg" | "xl" | "2xl")[] | undefined;
141
- columns?: {
142
- xs?: number | undefined;
143
- sm?: number | undefined;
144
- md?: number | undefined;
145
- lg?: number | undefined;
146
- xl?: number | undefined;
147
- '2xl'?: number | undefined;
148
- } | undefined;
149
- order?: {
150
- xs?: number | undefined;
151
- sm?: number | undefined;
152
- md?: number | undefined;
153
- lg?: number | undefined;
154
- xl?: number | undefined;
155
- '2xl'?: number | undefined;
156
- } | undefined;
157
- } | undefined;
158
- aria?: {
159
- ariaLabel?: string | undefined;
160
- ariaDescribedBy?: string | undefined;
161
- role?: string | undefined;
162
- } | undefined;
163
- }[];
164
- description?: string | undefined;
165
- header?: {
166
- showTitle: boolean;
167
- showDescription: boolean;
168
- actions?: {
169
- label: string;
170
- actionUrl: string;
171
- actionType?: "url" | "api" | "modal" | "flow" | "script" | undefined;
172
- icon?: string | undefined;
173
- }[] | undefined;
174
- } | undefined;
175
- columns?: number | undefined;
176
- gap?: number | undefined;
177
- refreshInterval?: number | undefined;
178
- dateRange?: {
179
- 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";
180
- allowCustomRange: boolean;
181
- field?: string | undefined;
182
- } | undefined;
183
- globalFilters?: {
184
- field: string;
185
- scope: "dashboard" | "widget";
186
- label?: string | undefined;
187
- type?: "number" | "date" | "text" | "select" | "lookup" | undefined;
188
- options?: {
189
- value: string | number | boolean;
190
- label: string;
191
- }[] | undefined;
192
- optionsFrom?: {
193
- object: string;
194
- valueField: string;
195
- labelField: string;
196
- filter?: _objectstack_spec_data.FilterCondition | undefined;
197
- } | undefined;
198
- defaultValue?: string | number | boolean | undefined;
199
- targetWidgets?: string[] | undefined;
200
- }[] | undefined;
201
- aria?: {
202
- ariaLabel?: string | undefined;
203
- ariaDescribedBy?: string | undefined;
204
- role?: string | undefined;
205
- } | undefined;
206
- performance?: {
207
- lazyLoad?: boolean | undefined;
208
- virtualScroll?: {
209
- enabled: boolean;
210
- itemHeight?: number | undefined;
211
- overscan?: number | undefined;
212
- } | undefined;
213
- cacheStrategy?: "none" | "cache-first" | "network-first" | "stale-while-revalidate" | undefined;
214
- prefetch?: boolean | undefined;
215
- pageSize?: number | undefined;
216
- debounceMs?: number | undefined;
217
- } | undefined;
218
- };
219
-
220
- /**
221
- * Security Overview Dashboard
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.
222
38
  *
223
- * Provides security and compliance monitoring:
224
- * - User authentication events
225
- * - Permission changes
226
- * - System configuration audits
227
- * - Active user sessions
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
228
44
  */
229
- declare const SecurityOverviewDashboard: {
45
+ declare const SystemOverviewDashboard: {
230
46
  name: string;
231
47
  label: string;
232
48
  widgets: {
@@ -434,7 +250,6 @@ declare const SetupAppTranslations: TranslationBundle;
434
250
  * - `apps.setup.label` / `description`
435
251
  * - `apps.setup.navigation.<id>.label` for every group AND leaf
436
252
  * - `dashboards.system_overview.*`
437
- * - `dashboards.security_overview.*`
438
253
  *
439
254
  * Object-level labels (Users, Roles, Audit Logs, …) are owned by the
440
255
  * sys_* object schemas themselves and translated separately.
@@ -456,4 +271,4 @@ declare const jaJP: TranslationData;
456
271
  */
457
272
  declare const esES: TranslationData;
458
273
 
459
- export { SETUP_APP, SecurityOverviewDashboard, SetupAppTranslations, SystemOverviewDashboard, en, esES, jaJP, zhCN };
274
+ export { SETUP_APP, SetupAppTranslations, SystemOverviewDashboard, en, esES, jaJP, zhCN };