@asteby/metacore-runtime-react 52.1.0 → 53.0.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.
- package/CHANGELOG.md +18 -0
- package/dist/addon-loader.d.ts +22 -1
- package/dist/addon-loader.d.ts.map +1 -1
- package/dist/addon-loader.js +23 -5
- package/dist/addon-page-host.d.ts +80 -0
- package/dist/addon-page-host.d.ts.map +1 -0
- package/dist/addon-page-host.js +216 -0
- package/dist/addon-page-loader.d.ts +40 -0
- package/dist/addon-page-loader.d.ts.map +1 -0
- package/dist/addon-page-loader.js +87 -0
- package/dist/dynamic-view.d.ts +20 -1
- package/dist/dynamic-view.d.ts.map +1 -1
- package/dist/dynamic-view.js +26 -3
- package/dist/federated-error-boundary.d.ts +46 -0
- package/dist/federated-error-boundary.d.ts.map +1 -0
- package/dist/federated-error-boundary.js +55 -0
- package/dist/host-api.d.ts +22 -0
- package/dist/host-api.d.ts.map +1 -0
- package/dist/host-api.js +113 -0
- package/dist/index.d.ts +6 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -1
- package/dist/testing.d.ts +42 -0
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +53 -0
- package/dist/types.d.ts +13 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/views/calendar-view.d.ts +23 -0
- package/dist/views/calendar-view.d.ts.map +1 -0
- package/dist/views/calendar-view.js +138 -0
- package/dist/views/chart-view.d.ts +14 -0
- package/dist/views/chart-view.d.ts.map +1 -0
- package/dist/views/chart-view.js +77 -0
- package/dist/views/data-source.d.ts +30 -0
- package/dist/views/data-source.d.ts.map +1 -0
- package/dist/views/data-source.js +103 -0
- package/dist/views/index.d.ts +4 -0
- package/dist/views/index.d.ts.map +1 -0
- package/dist/views/index.js +2 -0
- package/dist/views/map-view.d.ts +39 -0
- package/dist/views/map-view.d.ts.map +1 -0
- package/dist/views/map-view.js +143 -0
- package/dist/views/panels.d.ts +13 -0
- package/dist/views/panels.d.ts.map +1 -0
- package/dist/views/panels.js +119 -0
- package/dist/views/registry.d.ts +46 -0
- package/dist/views/registry.d.ts.map +1 -0
- package/dist/views/registry.js +139 -0
- package/dist/views/skeleton.d.ts +5 -0
- package/dist/views/skeleton.d.ts.map +1 -0
- package/dist/views/skeleton.js +6 -0
- package/dist/views/split-view.d.ts +6 -0
- package/dist/views/split-view.d.ts.map +1 -0
- package/dist/views/split-view.js +52 -0
- package/dist/views/timeline-view.d.ts +25 -0
- package/dist/views/timeline-view.d.ts.map +1 -0
- package/dist/views/timeline-view.js +130 -0
- package/dist/views/types.d.ts +87 -0
- package/dist/views/types.d.ts.map +1 -0
- package/dist/views/types.js +1 -0
- package/package.json +16 -4
- package/src/__tests__/addon-page-host.test.tsx +122 -0
- package/src/__tests__/addon-page-loader.test.tsx +201 -0
- package/src/__tests__/declarative-views.test.tsx +351 -0
- package/src/__tests__/host-api.test.ts +87 -0
- package/src/__tests__/index-static-graph.test.ts +18 -0
- package/src/addon-loader.tsx +51 -8
- package/src/addon-page-host.tsx +319 -0
- package/src/addon-page-loader.tsx +203 -0
- package/src/dynamic-view.tsx +61 -3
- package/src/federated-error-boundary.tsx +121 -0
- package/src/host-api.ts +143 -0
- package/src/index.ts +38 -0
- package/src/testing.tsx +108 -0
- package/src/types.ts +13 -0
- package/src/views/calendar-view.tsx +234 -0
- package/src/views/chart-view.tsx +122 -0
- package/src/views/data-source.ts +127 -0
- package/src/views/index.ts +37 -0
- package/src/views/map-view.tsx +217 -0
- package/src/views/panels.tsx +177 -0
- package/src/views/registry.tsx +202 -0
- package/src/views/skeleton.tsx +13 -0
- package/src/views/split-view.tsx +115 -0
- package/src/views/timeline-view.tsx +229 -0
- package/src/views/types.ts +105 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
// Declarative view & panel renderer registry.
|
|
2
|
+
//
|
|
3
|
+
// Every renderer is a separate lazy chunk keyed by type: an addon that only
|
|
4
|
+
// declares a `timeline` never downloads the chart, calendar or map code, and
|
|
5
|
+
// none of them is in the host's first paint (the package index reaches this
|
|
6
|
+
// module, never the renderers — see __tests__/index-static-graph.test.ts).
|
|
7
|
+
//
|
|
8
|
+
// Built-in: chart, timeline, calendar, split (views) and map/timeline/chart/
|
|
9
|
+
// relation/stats (panels). `map` ships an accessible list fallback until a
|
|
10
|
+
// maps package registers the real renderer:
|
|
11
|
+
//
|
|
12
|
+
// registerViewRenderer('map', () => import('@asteby/metacore-maps/view'))
|
|
13
|
+
// registerPanelRenderer('map', () => import('@asteby/metacore-maps/panel'))
|
|
14
|
+
//
|
|
15
|
+
// `custom` panels (level C, a federated component) have no built-in: the host
|
|
16
|
+
// registers one that mounts the addon's expose.
|
|
17
|
+
import * as React from 'react'
|
|
18
|
+
import type { DetailPanel, NavView } from '@asteby/metacore-sdk'
|
|
19
|
+
import type {
|
|
20
|
+
DeclarativeViewType,
|
|
21
|
+
PanelRendererComponent,
|
|
22
|
+
PanelRendererLoader,
|
|
23
|
+
PanelRendererProps,
|
|
24
|
+
ViewRendererComponent,
|
|
25
|
+
ViewRendererLoader,
|
|
26
|
+
ViewRendererProps,
|
|
27
|
+
} from './types'
|
|
28
|
+
import { FederatedErrorBoundary } from '../federated-error-boundary'
|
|
29
|
+
import { ViewSkeleton } from './skeleton'
|
|
30
|
+
|
|
31
|
+
export { ViewSkeleton }
|
|
32
|
+
|
|
33
|
+
export const DECLARATIVE_VIEW_TYPES: readonly DeclarativeViewType[] = [
|
|
34
|
+
'map',
|
|
35
|
+
'timeline',
|
|
36
|
+
'calendar',
|
|
37
|
+
'chart',
|
|
38
|
+
'split',
|
|
39
|
+
] as const
|
|
40
|
+
|
|
41
|
+
export function isDeclarativeViewType(t: string | undefined | null): t is DeclarativeViewType {
|
|
42
|
+
return !!t && (DECLARATIVE_VIEW_TYPES as readonly string[]).includes(t)
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
const viewLoaders = new Map<string, ViewRendererLoader>([
|
|
46
|
+
['chart', () => import('./chart-view')],
|
|
47
|
+
['timeline', () => import('./timeline-view')],
|
|
48
|
+
['calendar', () => import('./calendar-view')],
|
|
49
|
+
['split', () => import('./split-view')],
|
|
50
|
+
['map', () => import('./map-view')],
|
|
51
|
+
])
|
|
52
|
+
|
|
53
|
+
const panelLoaders = new Map<string, PanelRendererLoader>([
|
|
54
|
+
['chart', () => import('./chart-view').then((m) => ({ default: m.ChartPanel }))],
|
|
55
|
+
['timeline', () => import('./timeline-view').then((m) => ({ default: m.TimelinePanel }))],
|
|
56
|
+
['map', () => import('./map-view').then((m) => ({ default: m.MapPanel }))],
|
|
57
|
+
['relation', () => import('./panels').then((m) => ({ default: m.RelationPanelView }))],
|
|
58
|
+
['stats', () => import('./panels').then((m) => ({ default: m.StatsPanelView }))],
|
|
59
|
+
])
|
|
60
|
+
|
|
61
|
+
const lazyViews = new Map<string, React.LazyExoticComponent<ViewRendererComponent>>()
|
|
62
|
+
const lazyPanels = new Map<string, React.LazyExoticComponent<PanelRendererComponent>>()
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Register (or replace) the renderer of a view type. Returns a function that
|
|
66
|
+
* restores the previous loader. Replacing drops the cached lazy component.
|
|
67
|
+
*/
|
|
68
|
+
export function registerViewRenderer(type: string, loader: ViewRendererLoader): () => void {
|
|
69
|
+
const prev = viewLoaders.get(type)
|
|
70
|
+
viewLoaders.set(type, loader)
|
|
71
|
+
lazyViews.delete(type)
|
|
72
|
+
return () => {
|
|
73
|
+
if (prev) viewLoaders.set(type, prev)
|
|
74
|
+
else viewLoaders.delete(type)
|
|
75
|
+
lazyViews.delete(type)
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/** Register (or replace) the renderer of a detail panel kind (incl. `custom`). */
|
|
80
|
+
export function registerPanelRenderer(kind: string, loader: PanelRendererLoader): () => void {
|
|
81
|
+
const prev = panelLoaders.get(kind)
|
|
82
|
+
panelLoaders.set(kind, loader)
|
|
83
|
+
lazyPanels.delete(kind)
|
|
84
|
+
return () => {
|
|
85
|
+
if (prev) panelLoaders.set(kind, prev)
|
|
86
|
+
else panelLoaders.delete(kind)
|
|
87
|
+
lazyPanels.delete(kind)
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function hasViewRenderer(type: string): boolean {
|
|
92
|
+
return viewLoaders.has(type)
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function hasPanelRenderer(kind: string): boolean {
|
|
96
|
+
return panelLoaders.has(kind)
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/** Warm a renderer chunk (hover/focus on a nav entry). Resolves false when none. */
|
|
100
|
+
export function preloadViewRenderer(type: string): Promise<boolean> {
|
|
101
|
+
const loader = viewLoaders.get(type)
|
|
102
|
+
return loader ? loader().then(() => true, () => false) : Promise.resolve(false)
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
function lazyView(type: string): React.LazyExoticComponent<ViewRendererComponent> | null {
|
|
106
|
+
const loader = viewLoaders.get(type)
|
|
107
|
+
if (!loader) return null
|
|
108
|
+
let c = lazyViews.get(type)
|
|
109
|
+
if (!c) {
|
|
110
|
+
c = React.lazy(loader)
|
|
111
|
+
lazyViews.set(type, c)
|
|
112
|
+
}
|
|
113
|
+
return c
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
function lazyPanel(kind: string): React.LazyExoticComponent<PanelRendererComponent> | null {
|
|
117
|
+
const loader = panelLoaders.get(kind)
|
|
118
|
+
if (!loader) return null
|
|
119
|
+
let c = lazyPanels.get(kind)
|
|
120
|
+
if (!c) {
|
|
121
|
+
c = React.lazy(loader)
|
|
122
|
+
lazyPanels.set(kind, c)
|
|
123
|
+
}
|
|
124
|
+
return c
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
export interface DeclarativeViewProps extends Omit<ViewRendererProps, 'view'> {
|
|
128
|
+
viewType: DeclarativeViewType | string
|
|
129
|
+
/** The nav entry's `view` block (served in the table metadata). */
|
|
130
|
+
view: NavView | null | undefined
|
|
131
|
+
/** Rendered when the type has no renderer or its block is missing. */
|
|
132
|
+
fallback?: React.ReactNode
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Render a declarative view by type: picks `view[viewType]`, lazy-loads that
|
|
137
|
+
* renderer, isolates it in an error boundary. Unknown types render `fallback`
|
|
138
|
+
* (hosts pass the table, the same rule DynamicView applies).
|
|
139
|
+
*/
|
|
140
|
+
export function DeclarativeView({ viewType, view, fallback = null, ...rest }: DeclarativeViewProps) {
|
|
141
|
+
const block = (view as Record<string, unknown> | null | undefined)?.[viewType]
|
|
142
|
+
const Renderer = lazyView(viewType)
|
|
143
|
+
if (!Renderer || !block) return <>{fallback}</>
|
|
144
|
+
return (
|
|
145
|
+
<FederatedErrorBoundary addonKey={`view:${viewType}`} resetKeys={[rest.model, viewType]}>
|
|
146
|
+
<React.Suspense fallback={<ViewSkeleton />}>
|
|
147
|
+
<Renderer {...rest} view={block} />
|
|
148
|
+
</React.Suspense>
|
|
149
|
+
</FederatedErrorBoundary>
|
|
150
|
+
)
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
export interface DetailPanelsProps extends Omit<PanelRendererProps, 'panel'> {
|
|
154
|
+
panels: DetailPanel[] | null | undefined
|
|
155
|
+
/** Permission check for `panel.permission` (default: everything visible). */
|
|
156
|
+
can?: (permission: string) => boolean
|
|
157
|
+
/** i18n for panel titles (raw keys pass through by default). */
|
|
158
|
+
translate?: (key: string) => string
|
|
159
|
+
className?: string
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Detail panels of a record in a 2-column grid (`span: half` takes one
|
|
164
|
+
* column, `full` both). Each panel is lazy and isolated: one failing panel
|
|
165
|
+
* never blanks the detail page.
|
|
166
|
+
*/
|
|
167
|
+
export function DetailPanels({ panels, can, translate, className, ...rest }: DetailPanelsProps) {
|
|
168
|
+
const visible = (panels ?? []).filter((p) => !p.permission || !can || can(p.permission))
|
|
169
|
+
if (visible.length === 0) return null
|
|
170
|
+
const tr = translate ?? ((k: string) => k)
|
|
171
|
+
return (
|
|
172
|
+
<div className={['grid grid-cols-1 gap-4 lg:grid-cols-2', className].filter(Boolean).join(' ')}>
|
|
173
|
+
{visible.map((panel) => {
|
|
174
|
+
const Renderer = lazyPanel(panel.kind)
|
|
175
|
+
return (
|
|
176
|
+
<section
|
|
177
|
+
key={panel.key}
|
|
178
|
+
data-panel={panel.key}
|
|
179
|
+
aria-label={tr(panel.title)}
|
|
180
|
+
className={[
|
|
181
|
+
'min-w-0 rounded-lg border bg-card p-4',
|
|
182
|
+
panel.span === 'half' ? '' : 'lg:col-span-2',
|
|
183
|
+
].join(' ')}
|
|
184
|
+
>
|
|
185
|
+
<h3 className="mb-3 text-sm font-medium text-foreground">{tr(panel.title)}</h3>
|
|
186
|
+
{Renderer ? (
|
|
187
|
+
<FederatedErrorBoundary addonKey={`panel:${panel.key}`} resetKeys={[rest.record]}>
|
|
188
|
+
<React.Suspense fallback={<ViewSkeleton height={200} />}>
|
|
189
|
+
<Renderer {...rest} panel={panel} />
|
|
190
|
+
</React.Suspense>
|
|
191
|
+
</FederatedErrorBoundary>
|
|
192
|
+
) : (
|
|
193
|
+
<p className="text-xs text-muted-foreground" data-testid="panel-unsupported">
|
|
194
|
+
{panel.kind}
|
|
195
|
+
</p>
|
|
196
|
+
)}
|
|
197
|
+
</section>
|
|
198
|
+
)
|
|
199
|
+
})}
|
|
200
|
+
</div>
|
|
201
|
+
)
|
|
202
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// Fixed-height placeholder shared by the registry and the lazy renderers.
|
|
2
|
+
|
|
3
|
+
/** Fixed-height skeleton (no layout shift while a renderer chunk loads). */
|
|
4
|
+
export function ViewSkeleton({ height = 360 }: { height?: number }) {
|
|
5
|
+
return (
|
|
6
|
+
<div
|
|
7
|
+
aria-busy="true"
|
|
8
|
+
data-testid="view-skeleton"
|
|
9
|
+
className="w-full animate-pulse rounded-lg bg-muted"
|
|
10
|
+
style={{ height }}
|
|
11
|
+
/>
|
|
12
|
+
)
|
|
13
|
+
}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
// `view_type: split` — master-detail on one screen: the model's list (the
|
|
2
|
+
// same DynamicTable every model uses, restricted to `split.columns`) and the
|
|
3
|
+
// selected record's detail panels (`split.panels`, else the model's
|
|
4
|
+
// `detail.panels`). Stacks below 1280 px. Lazy chunk.
|
|
5
|
+
import * as React from 'react'
|
|
6
|
+
import { useTranslation } from 'react-i18next'
|
|
7
|
+
import { X } from 'lucide-react'
|
|
8
|
+
import { Button } from '@asteby/metacore-ui/primitives'
|
|
9
|
+
import { DynamicTable } from '../dynamic-table'
|
|
10
|
+
import type { ViewRendererProps } from './types'
|
|
11
|
+
import { DetailPanels } from './registry'
|
|
12
|
+
import { displayValue } from './data-source'
|
|
13
|
+
import { ViewSkeleton } from './skeleton'
|
|
14
|
+
|
|
15
|
+
/** Pure: which metadata columns to hide so the list shows only `columns`. */
|
|
16
|
+
export function hiddenColumnsFor(allColumns: string[], columns: string[] | undefined): string[] {
|
|
17
|
+
if (!columns || columns.length === 0) return []
|
|
18
|
+
const keep = new Set(columns)
|
|
19
|
+
return allColumns.filter((c) => !keep.has(c))
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export default function SplitViewRenderer(props: ViewRendererProps<'split'>) {
|
|
23
|
+
const { model, view, metadata, data, locale, currency, timeZone, className } = props
|
|
24
|
+
const { t } = useTranslation()
|
|
25
|
+
const [selected, setSelected] = React.useState<Record<string, unknown> | null>(null)
|
|
26
|
+
const [record, setRecord] = React.useState<Record<string, unknown> | null>(null)
|
|
27
|
+
const detailRef = React.useRef<HTMLElement>(null)
|
|
28
|
+
|
|
29
|
+
const selectedId = selected?.id !== undefined && selected?.id !== null ? String(selected.id) : null
|
|
30
|
+
React.useEffect(() => {
|
|
31
|
+
if (!selectedId) {
|
|
32
|
+
setRecord(null)
|
|
33
|
+
return
|
|
34
|
+
}
|
|
35
|
+
let cancelled = false
|
|
36
|
+
setRecord(null)
|
|
37
|
+
data.record(model, selectedId).then(
|
|
38
|
+
(r) => !cancelled && setRecord(r ?? selected),
|
|
39
|
+
// The list row is still a usable record for the panels.
|
|
40
|
+
() => !cancelled && setRecord(selected),
|
|
41
|
+
)
|
|
42
|
+
return () => {
|
|
43
|
+
cancelled = true
|
|
44
|
+
}
|
|
45
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
46
|
+
}, [data, model, selectedId])
|
|
47
|
+
|
|
48
|
+
// Move focus to the detail for keyboard and screen-reader users.
|
|
49
|
+
React.useEffect(() => {
|
|
50
|
+
if (record) detailRef.current?.focus()
|
|
51
|
+
}, [record])
|
|
52
|
+
|
|
53
|
+
const hidden = React.useMemo(
|
|
54
|
+
() => hiddenColumnsFor((metadata?.columns ?? []).map((c) => c.key), view.columns),
|
|
55
|
+
[metadata, view.columns],
|
|
56
|
+
)
|
|
57
|
+
const panels = view.panels ?? metadata?.detail?.panels ?? []
|
|
58
|
+
const titleKey = view.columns?.[0]
|
|
59
|
+
|
|
60
|
+
return (
|
|
61
|
+
<div className={['grid gap-4 xl:grid-cols-[minmax(0,1fr)_minmax(0,1.1fr)]', className].filter(Boolean).join(' ')} data-testid="split-view">
|
|
62
|
+
<div className="min-w-0">
|
|
63
|
+
<DynamicTable
|
|
64
|
+
model={model}
|
|
65
|
+
hiddenColumns={hidden}
|
|
66
|
+
onRowClick={(row: Record<string, unknown>) => setSelected(row)}
|
|
67
|
+
timeZone={timeZone}
|
|
68
|
+
currency={currency}
|
|
69
|
+
/>
|
|
70
|
+
</div>
|
|
71
|
+
<section
|
|
72
|
+
ref={detailRef}
|
|
73
|
+
tabIndex={-1}
|
|
74
|
+
aria-live="polite"
|
|
75
|
+
aria-label={t('metacore.views.detail', 'Detalle')}
|
|
76
|
+
className="min-w-0 rounded-lg border bg-background p-4 outline-none xl:sticky xl:top-4 xl:max-h-[calc(100dvh-8rem)] xl:overflow-auto"
|
|
77
|
+
>
|
|
78
|
+
{!selected ? (
|
|
79
|
+
<p className="py-16 text-center text-sm text-muted-foreground" data-testid="split-empty">
|
|
80
|
+
{t('metacore.views.select_record', 'Selecciona un registro para ver su detalle.')}
|
|
81
|
+
</p>
|
|
82
|
+
) : !record ? (
|
|
83
|
+
<ViewSkeleton height={240} />
|
|
84
|
+
) : (
|
|
85
|
+
<>
|
|
86
|
+
<header className="mb-4 flex items-start justify-between gap-2">
|
|
87
|
+
<h2 className="text-base font-semibold text-foreground">
|
|
88
|
+
{displayValue(titleKey ? record[titleKey] : record.id)}
|
|
89
|
+
</h2>
|
|
90
|
+
<Button
|
|
91
|
+
variant="ghost"
|
|
92
|
+
size="icon"
|
|
93
|
+
aria-label={t('metacore.views.close_detail', 'Cerrar detalle')}
|
|
94
|
+
onClick={() => setSelected(null)}
|
|
95
|
+
>
|
|
96
|
+
<X aria-hidden className="h-4 w-4" />
|
|
97
|
+
</Button>
|
|
98
|
+
</header>
|
|
99
|
+
<DetailPanels
|
|
100
|
+
model={model}
|
|
101
|
+
panels={panels}
|
|
102
|
+
record={record}
|
|
103
|
+
metadata={metadata}
|
|
104
|
+
data={data}
|
|
105
|
+
locale={locale}
|
|
106
|
+
currency={currency}
|
|
107
|
+
timeZone={timeZone}
|
|
108
|
+
translate={(k) => t(k)}
|
|
109
|
+
/>
|
|
110
|
+
</>
|
|
111
|
+
)}
|
|
112
|
+
</section>
|
|
113
|
+
</div>
|
|
114
|
+
)
|
|
115
|
+
}
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
// `view_type: timeline` (a model's rows over time) and `kind: timeline` detail
|
|
2
|
+
// panels (a record's child rows, or the items of a capability query such as
|
|
3
|
+
// `commerce.shipping.track`). Lazy chunk. Dates are formatted, never computed:
|
|
4
|
+
// ETAs and statuses are whatever the server returned.
|
|
5
|
+
import * as React from 'react'
|
|
6
|
+
import { useTranslation } from 'react-i18next'
|
|
7
|
+
import { Badge, Button } from '@asteby/metacore-ui/primitives'
|
|
8
|
+
import type { TimelineView } from '@asteby/metacore-sdk'
|
|
9
|
+
import { buildRelationFilterParams } from '../dynamic-relation-helpers'
|
|
10
|
+
import type { PanelRendererProps, ViewRendererProps } from './types'
|
|
11
|
+
import {
|
|
12
|
+
displayValue,
|
|
13
|
+
pickItems,
|
|
14
|
+
resolveCapabilityInput,
|
|
15
|
+
sortByDate,
|
|
16
|
+
toDate,
|
|
17
|
+
} from './data-source'
|
|
18
|
+
import { ViewSkeleton } from './skeleton'
|
|
19
|
+
|
|
20
|
+
const PAGE = 50
|
|
21
|
+
|
|
22
|
+
export interface TimelineEntry {
|
|
23
|
+
key: string
|
|
24
|
+
at: Date | null
|
|
25
|
+
title: string
|
|
26
|
+
status?: string
|
|
27
|
+
description?: string
|
|
28
|
+
group?: string
|
|
29
|
+
row: Record<string, unknown>
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/** Pure: rows → ordered entries (newest first), grouped when `group_by` is set. */
|
|
33
|
+
export function toTimelineEntries(rows: Record<string, unknown>[], view: TimelineView): TimelineEntry[] {
|
|
34
|
+
return sortByDate(rows, view.date_field).map((row, i) => ({
|
|
35
|
+
key: String(row.id ?? `${i}`),
|
|
36
|
+
at: toDate(row[view.date_field]),
|
|
37
|
+
title: displayValue(row[view.title_field]),
|
|
38
|
+
status: view.status_field ? displayValue(row[view.status_field]) || undefined : undefined,
|
|
39
|
+
description: view.description_field ? displayValue(row[view.description_field]) || undefined : undefined,
|
|
40
|
+
group: view.group_by ? displayValue(row[view.group_by]) || undefined : undefined,
|
|
41
|
+
row,
|
|
42
|
+
}))
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function useFormatter(locale?: string, timeZone?: string) {
|
|
46
|
+
return React.useMemo(() => {
|
|
47
|
+
try {
|
|
48
|
+
return new Intl.DateTimeFormat(locale, { dateStyle: 'medium', timeStyle: 'short', timeZone })
|
|
49
|
+
} catch {
|
|
50
|
+
return new Intl.DateTimeFormat(undefined, { dateStyle: 'medium', timeStyle: 'short' })
|
|
51
|
+
}
|
|
52
|
+
}, [locale, timeZone])
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export function TimelineList({
|
|
56
|
+
entries,
|
|
57
|
+
locale,
|
|
58
|
+
timeZone,
|
|
59
|
+
onOpen,
|
|
60
|
+
}: {
|
|
61
|
+
entries: TimelineEntry[]
|
|
62
|
+
locale?: string
|
|
63
|
+
timeZone?: string
|
|
64
|
+
onOpen?: (row: Record<string, unknown>) => void
|
|
65
|
+
}) {
|
|
66
|
+
const { t } = useTranslation()
|
|
67
|
+
const fmt = useFormatter(locale, timeZone)
|
|
68
|
+
if (entries.length === 0) {
|
|
69
|
+
return (
|
|
70
|
+
<p className="py-8 text-center text-sm text-muted-foreground" data-testid="timeline-empty">
|
|
71
|
+
{t('metacore.views.empty', 'Sin datos todavía.')}
|
|
72
|
+
</p>
|
|
73
|
+
)
|
|
74
|
+
}
|
|
75
|
+
let lastGroup: string | undefined
|
|
76
|
+
return (
|
|
77
|
+
<ol className="relative space-y-4 border-l border-border pl-5" data-testid="timeline">
|
|
78
|
+
{entries.map((e) => {
|
|
79
|
+
const header = e.group !== undefined && e.group !== lastGroup ? e.group : undefined
|
|
80
|
+
lastGroup = e.group
|
|
81
|
+
const body = (
|
|
82
|
+
<>
|
|
83
|
+
<span
|
|
84
|
+
aria-hidden
|
|
85
|
+
className="absolute -left-[5px] mt-1.5 h-2.5 w-2.5 rounded-full border-2 border-background bg-primary"
|
|
86
|
+
/>
|
|
87
|
+
<div className="flex flex-wrap items-center gap-2">
|
|
88
|
+
<span className="text-sm font-medium text-foreground">{e.title}</span>
|
|
89
|
+
{e.status ? <Badge variant="outline">{e.status}</Badge> : null}
|
|
90
|
+
</div>
|
|
91
|
+
{e.at ? (
|
|
92
|
+
<time dateTime={e.at.toISOString()} className="block text-xs text-muted-foreground">
|
|
93
|
+
{fmt.format(e.at)}
|
|
94
|
+
</time>
|
|
95
|
+
) : null}
|
|
96
|
+
{e.description ? <p className="mt-1 text-sm text-muted-foreground">{e.description}</p> : null}
|
|
97
|
+
</>
|
|
98
|
+
)
|
|
99
|
+
return (
|
|
100
|
+
<React.Fragment key={e.key}>
|
|
101
|
+
{header ? (
|
|
102
|
+
<li className="-ml-5 pt-2 text-xs font-semibold uppercase tracking-wide text-muted-foreground">
|
|
103
|
+
{header}
|
|
104
|
+
</li>
|
|
105
|
+
) : null}
|
|
106
|
+
<li className="relative">
|
|
107
|
+
{onOpen ? (
|
|
108
|
+
<button
|
|
109
|
+
type="button"
|
|
110
|
+
className="w-full rounded-md text-left focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
|
|
111
|
+
onClick={() => onOpen(e.row)}
|
|
112
|
+
>
|
|
113
|
+
{body}
|
|
114
|
+
</button>
|
|
115
|
+
) : (
|
|
116
|
+
body
|
|
117
|
+
)}
|
|
118
|
+
</li>
|
|
119
|
+
</React.Fragment>
|
|
120
|
+
)
|
|
121
|
+
})}
|
|
122
|
+
</ol>
|
|
123
|
+
)
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
/** `view_type: timeline` on a nav entry: the model's rows, newest first, paged. */
|
|
127
|
+
export default function TimelineViewRenderer(props: ViewRendererProps<'timeline'>) {
|
|
128
|
+
const { model, view, data, locale, timeZone, onOpenRecord, className } = props
|
|
129
|
+
const { t } = useTranslation()
|
|
130
|
+
const [rows, setRows] = React.useState<Record<string, unknown>[] | null>(null)
|
|
131
|
+
const [total, setTotal] = React.useState<number | undefined>()
|
|
132
|
+
const [page, setPage] = React.useState(1)
|
|
133
|
+
const [error, setError] = React.useState(false)
|
|
134
|
+
|
|
135
|
+
React.useEffect(() => {
|
|
136
|
+
let cancelled = false
|
|
137
|
+
setError(false)
|
|
138
|
+
data
|
|
139
|
+
.list(model, { page, per_page: PAGE, sortBy: view.date_field, order: 'desc' })
|
|
140
|
+
.then((res) => {
|
|
141
|
+
if (cancelled) return
|
|
142
|
+
setRows((prev) => (page === 1 || !prev ? res.rows : [...prev, ...res.rows]))
|
|
143
|
+
setTotal(res.total)
|
|
144
|
+
})
|
|
145
|
+
.catch(() => !cancelled && setError(true))
|
|
146
|
+
return () => {
|
|
147
|
+
cancelled = true
|
|
148
|
+
}
|
|
149
|
+
}, [data, model, view.date_field, page])
|
|
150
|
+
|
|
151
|
+
if (error && !rows) {
|
|
152
|
+
return (
|
|
153
|
+
<p role="alert" className="text-sm text-destructive">
|
|
154
|
+
{t('metacore.views.error', 'No se pudo cargar la información.')}
|
|
155
|
+
</p>
|
|
156
|
+
)
|
|
157
|
+
}
|
|
158
|
+
if (!rows) return <ViewSkeleton />
|
|
159
|
+
const entries = toTimelineEntries(rows, view)
|
|
160
|
+
const more = total !== undefined ? rows.length < total : false
|
|
161
|
+
return (
|
|
162
|
+
<div className={className}>
|
|
163
|
+
<TimelineList entries={entries} locale={locale} timeZone={timeZone} onOpen={onOpenRecord} />
|
|
164
|
+
{more ? (
|
|
165
|
+
<div className="mt-4 flex justify-center">
|
|
166
|
+
<Button variant="outline" size="sm" onClick={() => setPage((p) => p + 1)}>
|
|
167
|
+
{t('metacore.views.load_more', 'Cargar más')}
|
|
168
|
+
</Button>
|
|
169
|
+
</div>
|
|
170
|
+
) : null}
|
|
171
|
+
</div>
|
|
172
|
+
)
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
/** `kind: timeline` panel: child rows of a relation or a capability's items. */
|
|
176
|
+
export function TimelinePanel({ panel, record, metadata, data, locale, timeZone }: PanelRendererProps) {
|
|
177
|
+
const { t } = useTranslation()
|
|
178
|
+
const view = panel.timeline
|
|
179
|
+
const source = view?.source
|
|
180
|
+
const [rows, setRows] = React.useState<Record<string, unknown>[] | null>(null)
|
|
181
|
+
const [error, setError] = React.useState(false)
|
|
182
|
+
const recordId = record.id
|
|
183
|
+
const sig = JSON.stringify([source, recordId])
|
|
184
|
+
|
|
185
|
+
React.useEffect(() => {
|
|
186
|
+
if (!view || !source) return
|
|
187
|
+
let cancelled = false
|
|
188
|
+
setRows(null)
|
|
189
|
+
setError(false)
|
|
190
|
+
const run = async (): Promise<Record<string, unknown>[]> => {
|
|
191
|
+
if (source.capability) {
|
|
192
|
+
const out = await data.capability(source.capability, resolveCapabilityInput(source.input, record))
|
|
193
|
+
return pickItems(out, source.items)
|
|
194
|
+
}
|
|
195
|
+
if (source.relation) {
|
|
196
|
+
const rel = metadata?.relations?.find((r) => r.name === source.relation)
|
|
197
|
+
if (!rel || recordId === undefined || recordId === null) return []
|
|
198
|
+
const res = await data.list(rel.through, {
|
|
199
|
+
...buildRelationFilterParams(rel.foreign_key, String(recordId), rel.scope),
|
|
200
|
+
per_page: PAGE,
|
|
201
|
+
sortBy: view.date_field,
|
|
202
|
+
order: 'desc',
|
|
203
|
+
})
|
|
204
|
+
return res.rows
|
|
205
|
+
}
|
|
206
|
+
return []
|
|
207
|
+
}
|
|
208
|
+
run().then(
|
|
209
|
+
(r) => !cancelled && setRows(r),
|
|
210
|
+
() => !cancelled && setError(true),
|
|
211
|
+
)
|
|
212
|
+
return () => {
|
|
213
|
+
cancelled = true
|
|
214
|
+
}
|
|
215
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
216
|
+
}, [data, sig, metadata])
|
|
217
|
+
|
|
218
|
+
if (!view) return null
|
|
219
|
+
if (error) {
|
|
220
|
+
return (
|
|
221
|
+
<p role="alert" className="text-sm text-destructive">
|
|
222
|
+
{t('metacore.views.error', 'No se pudo cargar la información.')}
|
|
223
|
+
</p>
|
|
224
|
+
)
|
|
225
|
+
}
|
|
226
|
+
if (!rows) return <ViewSkeleton height={200} />
|
|
227
|
+
return <TimelineList entries={toTimelineEntries(rows, view)} locale={locale} timeZone={timeZone} />
|
|
228
|
+
}
|
|
229
|
+
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
// Declarative view contract (levels A/B of the UI spectrum): the kernel types
|
|
2
|
+
// (NavView, MapView, TimelineView, CalendarView, ChartView, SplitView,
|
|
3
|
+
// DetailPanel…) come generated from the kernel through @asteby/metacore-sdk;
|
|
4
|
+
// this file only adds the renderer-side props and the data source the host
|
|
5
|
+
// injects. Type-only: costs 0 bytes in the bundle.
|
|
6
|
+
import type { ComponentType } from 'react'
|
|
7
|
+
import type {
|
|
8
|
+
CalendarView,
|
|
9
|
+
ChartView,
|
|
10
|
+
DetailPanel,
|
|
11
|
+
MapView,
|
|
12
|
+
SplitView,
|
|
13
|
+
TimelineView,
|
|
14
|
+
WidgetQuery,
|
|
15
|
+
} from '@asteby/metacore-sdk'
|
|
16
|
+
import type { TableMetadata } from '../types'
|
|
17
|
+
import type { WidgetData } from '../dashboard-types'
|
|
18
|
+
|
|
19
|
+
/** `view_type` values rendered by a declarative renderer (table/kanban excluded). */
|
|
20
|
+
export type DeclarativeViewType = 'map' | 'timeline' | 'calendar' | 'chart' | 'split'
|
|
21
|
+
|
|
22
|
+
/** Block of `NavView` each type reads. */
|
|
23
|
+
export interface DeclarativeViewConfig {
|
|
24
|
+
map: MapView
|
|
25
|
+
timeline: TimelineView
|
|
26
|
+
calendar: CalendarView
|
|
27
|
+
chart: ChartView
|
|
28
|
+
split: SplitView
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/** A page of rows. */
|
|
32
|
+
export interface ViewRows<Row = Record<string, unknown>> {
|
|
33
|
+
rows: Row[]
|
|
34
|
+
total?: number
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/** List params in the kernel's list syntax (`f_<col>`, `sortBy`, `order`…). */
|
|
38
|
+
export type ViewListParams = Record<string, string | number | boolean | undefined>
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Where declarative renderers read data. The host provides it (default:
|
|
42
|
+
* {@link createApiViewDataSource} over the runtime-react ApiClient). Every
|
|
43
|
+
* call runs with the viewer's permissions server-side; renderers never
|
|
44
|
+
* compute business values (totals, ETAs) — they display what comes back.
|
|
45
|
+
*/
|
|
46
|
+
export interface ViewDataSource {
|
|
47
|
+
/** Rows of a model (`GET /data/<model>`). */
|
|
48
|
+
list(model: string, params?: ViewListParams): Promise<ViewRows>
|
|
49
|
+
/** One record (`GET /data/<model>/<id>`). */
|
|
50
|
+
record(model: string, id: string): Promise<Record<string, unknown> | null>
|
|
51
|
+
/**
|
|
52
|
+
* Aggregate for a chart view or panel. The host must only answer queries
|
|
53
|
+
* the installed manifests declare (same rule as dashboard widgets): the
|
|
54
|
+
* request names the model and the declared query, never free SQL.
|
|
55
|
+
*/
|
|
56
|
+
chart(req: ChartRequest): Promise<WidgetData>
|
|
57
|
+
/** Capability query (timeline panels with `source.capability`). */
|
|
58
|
+
capability(key: string, input: Record<string, unknown>): Promise<unknown>
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export interface ChartRequest {
|
|
62
|
+
/** Model whose nav entry / detail declares the chart. */
|
|
63
|
+
model: string
|
|
64
|
+
query: WidgetQuery
|
|
65
|
+
/** Detail panels: the relation the query is scoped to, and the record. */
|
|
66
|
+
relation?: string
|
|
67
|
+
recordId?: string
|
|
68
|
+
/** Detail panels: the panel key; nav views: undefined. */
|
|
69
|
+
panelKey?: string
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/** Props every declarative view renderer receives. */
|
|
73
|
+
export interface ViewRendererProps<T extends DeclarativeViewType = DeclarativeViewType> {
|
|
74
|
+
model: string
|
|
75
|
+
view: DeclarativeViewConfig[T]
|
|
76
|
+
/** Served table metadata (columns, relations, options…), when loaded. */
|
|
77
|
+
metadata?: TableMetadata | null
|
|
78
|
+
data: ViewDataSource
|
|
79
|
+
/** Open a record (host route to its detail page or drawer). */
|
|
80
|
+
onOpenRecord?: (row: Record<string, unknown>) => void
|
|
81
|
+
locale?: string
|
|
82
|
+
currency?: string
|
|
83
|
+
timeZone?: string
|
|
84
|
+
className?: string
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/** Props every detail panel renderer receives. */
|
|
88
|
+
export interface PanelRendererProps {
|
|
89
|
+
model: string
|
|
90
|
+
panel: DetailPanel
|
|
91
|
+
record: Record<string, unknown>
|
|
92
|
+
metadata?: TableMetadata | null
|
|
93
|
+
data: ViewDataSource
|
|
94
|
+
locale?: string
|
|
95
|
+
currency?: string
|
|
96
|
+
timeZone?: string
|
|
97
|
+
onOpenRecord?: (model: string, row: Record<string, unknown>) => void
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export type ViewRendererComponent = ComponentType<ViewRendererProps<any>>
|
|
101
|
+
export type PanelRendererComponent = ComponentType<PanelRendererProps>
|
|
102
|
+
|
|
103
|
+
/** Lazy module of a renderer (default export = the component). */
|
|
104
|
+
export type ViewRendererLoader = () => Promise<{ default: ViewRendererComponent }>
|
|
105
|
+
export type PanelRendererLoader = () => Promise<{ default: PanelRendererComponent }>
|