@object-ui/react 17.6.0 → 17.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.
- package/CHANGELOG.md +3766 -0
- package/README.md +294 -38
- package/dist/SchemaRenderer.d.ts +38 -7
- package/dist/SchemaRenderer.js +1218 -87
- package/dist/context/ActionContext.js +40 -1
- package/dist/context/DiscussionContext.d.ts +12 -0
- package/dist/context/DiscussionContext.js +2 -0
- package/dist/context/DrillNavigationContext.d.ts +13 -0
- package/dist/context/InlineEditContext.d.ts +81 -1
- package/dist/context/InlineEditContext.js +8 -2
- package/dist/context/RecordContext.d.ts +48 -5
- package/dist/context/RecordContext.js +10 -1
- package/dist/context/RelatedRecordActionsContext.d.ts +5 -1
- package/dist/context/SchemaRendererContext.d.ts +54 -2
- package/dist/context/SchemaRendererContext.js +38 -5
- package/dist/context/ThemeContext.js +1 -1
- package/dist/context/actionRunnerTranslator.d.ts +27 -0
- package/dist/context/actionRunnerTranslator.js +37 -0
- package/dist/element-data-source/ElementDataSourceGate.d.ts +88 -1
- package/dist/element-data-source/ElementDataSourceGate.js +326 -13
- package/dist/hooks/index.d.ts +3 -1
- package/dist/hooks/index.js +10 -1
- package/dist/hooks/useActionEngine.js +46 -3
- package/dist/hooks/useActionRunner.js +4 -0
- package/dist/hooks/useActionTextLocalizer.d.ts +21 -8
- package/dist/hooks/useActionTextLocalizer.js +33 -8
- package/dist/hooks/useConfigBagEvaluator.d.ts +30 -0
- package/dist/hooks/useConfigBagEvaluator.js +39 -0
- package/dist/hooks/useDensityMode.d.ts +6 -2
- package/dist/hooks/useDensityMode.js +6 -2
- package/dist/hooks/useDiscovery.d.ts +1 -10
- package/dist/hooks/useETagCache.js +25 -4
- package/dist/hooks/useElementDataSource.d.ts +15 -2
- package/dist/hooks/useElementDataSource.js +24 -7
- package/dist/hooks/useExpression.d.ts +52 -59
- package/dist/hooks/useExpression.js +58 -90
- package/dist/hooks/useFilterScope.d.ts +22 -2
- package/dist/hooks/useFilterScope.js +29 -4
- package/dist/hooks/useGlobalUndo.d.ts +10 -0
- package/dist/hooks/useGlobalUndo.js +112 -46
- package/dist/hooks/useNavigationOverlay.d.ts +76 -11
- package/dist/hooks/useNavigationOverlay.js +119 -9
- package/dist/hooks/useOffline.js +65 -11
- package/dist/hooks/usePageAssignment.d.ts +8 -5
- package/dist/hooks/usePageAssignment.js +37 -16
- package/dist/hooks/useRecordSearch.d.ts +34 -1
- package/dist/hooks/useRecordSearch.js +42 -7
- package/dist/hooks/useResolvedFilter.d.ts +46 -0
- package/dist/hooks/useResolvedFilter.js +130 -0
- package/dist/hooks/useSchemaPersistence.d.ts +7 -0
- package/dist/hooks/useSchemaPersistence.js +144 -5
- package/dist/hooks/useSettledSchema.d.ts +123 -0
- package/dist/hooks/useSettledSchema.js +186 -0
- package/dist/hooks/useViewData.d.ts +7 -2
- package/dist/index.d.ts +8 -1
- package/dist/index.js +45 -1
- package/dist/schema-input.d.ts +38 -8
- package/dist/schema-input.js +39 -7
- package/dist/utils/configBag.d.ts +68 -0
- package/dist/utils/configBag.js +70 -0
- package/dist/utils/error-message.d.ts +1 -1
- package/dist/utils/error-message.js +1 -1
- package/dist/utils/inlineAria.d.ts +61 -0
- package/dist/utils/inlineAria.js +70 -0
- package/dist/utils/nonGridRowCeiling.d.ts +44 -0
- package/dist/utils/nonGridRowCeiling.js +78 -0
- package/dist/utils/paramsBag.d.ts +28 -0
- package/dist/utils/paramsBag.js +146 -0
- package/dist/utils/propsBagDiagnostic.d.ts +196 -0
- package/dist/utils/propsBagDiagnostic.js +421 -0
- package/dist/utils/refusedDataPropDiagnostic.d.ts +44 -0
- package/dist/utils/refusedDataPropDiagnostic.js +94 -0
- package/dist/utils/unevaluatedExpression.d.ts +42 -1
- package/dist/utils/unevaluatedExpression.js +74 -11
- package/dist/utils/visibilityDiagnostic.d.ts +271 -19
- package/dist/utils/visibilityDiagnostic.js +311 -44
- package/package.json +10 -10
- package/dist/hooks/useClientNotifications.d.ts +0 -47
- package/dist/hooks/useClientNotifications.js +0 -162
- package/dist/spec-bridge/SpecBridge.d.ts +0 -28
- package/dist/spec-bridge/SpecBridge.js +0 -56
- package/dist/spec-bridge/bridges/form-view.d.ts +0 -158
- package/dist/spec-bridge/bridges/form-view.js +0 -170
- package/dist/spec-bridge/bridges/list-view.d.ts +0 -20
- package/dist/spec-bridge/bridges/list-view.js +0 -268
- package/dist/spec-bridge/index.d.ts +0 -11
- package/dist/spec-bridge/index.js +0 -10
- package/dist/spec-bridge/types.d.ts +0 -55
- package/dist/spec-bridge/types.js +0 -8
|
@@ -14,8 +14,80 @@
|
|
|
14
14
|
*
|
|
15
15
|
* Used by plugin-grid, plugin-list, plugin-detail and any component that needs
|
|
16
16
|
* NavigationConfig support.
|
|
17
|
+
*
|
|
18
|
+
* ## The RETIRED `view` key (objectui#9874)
|
|
19
|
+
*
|
|
20
|
+
* `view.list.navigation.view` was removed in `@objectstack/spec` 17.5.0 under
|
|
21
|
+
* ADR-0049 (enforce-or-remove). This hook was its one shipped consumer, and the
|
|
22
|
+
* spec's own tombstone describes THIS file: the authored value "was passed
|
|
23
|
+
* straight into the navigation-MODE argument of the console's `onNavigate`,
|
|
24
|
+
* where anything other than `edit` or `view` matched no branch, so the key
|
|
25
|
+
* selected nothing and could silently deaden the row click."
|
|
26
|
+
*
|
|
27
|
+
* ⭐ The point that is one character wide in the source and total in meaning:
|
|
28
|
+
* `onNavigate`'s second argument is the navigation MODE token, not a view name.
|
|
29
|
+
* An authored `view` did not SELECT a view, it SUBSTITUTED for the mode — so
|
|
30
|
+
* `{ mode: 'page', view: 'summary_view' }` dispatched `'summary_view'` into the
|
|
31
|
+
* slot a host reads against its closed `edit`/`view` vocabulary, matching
|
|
32
|
+
* neither branch. Two reads (`view ?? 'view'`, in the no-config and the `page`
|
|
33
|
+
* branch) are now the literal `'view'`, which is what every config without the
|
|
34
|
+
* key already dispatched and what every config dispatches now.
|
|
35
|
+
*
|
|
36
|
+
* The replacement route is NOT in this hook and no fallback belongs here. Per
|
|
37
|
+
* the same tombstone: to choose what opens for a record, assign a `record` page
|
|
38
|
+
* to the object and let `isDefault` pick the one that opens — page assignment
|
|
39
|
+
* is the machinery that resolves a detail layout, and a list view's
|
|
40
|
+
* `navigation` block only decides HOW the detail is surfaced (`mode`, `size`).
|
|
41
|
+
*
|
|
42
|
+
* ⚠️ `NavigationOverlayState` lost its `view` member with the read. It could
|
|
43
|
+
* only ever carry the retired key, so keeping it would publish a field that is
|
|
44
|
+
* permanently `undefined` — the same "declared, consumed, and wrong" state the
|
|
45
|
+
* retirement exists to end. Measured before removing it: zero readers of that
|
|
46
|
+
* member in this repository (`(navOverlay|nav|state).view` → no lines, against
|
|
47
|
+
* a lit control on its sibling members in the same command). Hosts outside this
|
|
48
|
+
* repository were NOT measured.
|
|
49
|
+
*
|
|
50
|
+
* ## `page` with no `onNavigate`: the HOST's record navigator (objectui#11293)
|
|
51
|
+
*
|
|
52
|
+
* `page` is the spec's default `mode`, so it is what `{ mode: 'page' }` and
|
|
53
|
+
* every authored block written without `mode` (`{ size: 'lg' }`) resolve to.
|
|
54
|
+
* The branch used to call `onNavigate` and nothing else, and a host that
|
|
55
|
+
* renders a block without wiring one — a board, a calendar, a gallery or a
|
|
56
|
+
* grid placed on a page as a standalone block — has no `onNavigate`: the
|
|
57
|
+
* click did nothing at all. Measured before the change: a standalone
|
|
58
|
+
* `object-kanban` / `object-calendar` with either spelling opened no overlay,
|
|
59
|
+
* called no navigation and no `window.open`, and a standalone `object-grid`
|
|
60
|
+
* did the same, because the grid's own `onNavigate` is host-supplied too.
|
|
61
|
+
*
|
|
62
|
+
* So when no `onNavigate` is supplied, a `page` click is handed to the record
|
|
63
|
+
* navigator the host PUBLISHES on `RelatedRecordActionsContext`
|
|
64
|
+
* (`openRecord(objectName, recordId)`). That is the seam the grid's link
|
|
65
|
+
* column and the lookup cells already read: the route is built by the host
|
|
66
|
+
* that owns it and never re-derived here, which is why this file still builds
|
|
67
|
+
* no record URL for `page`. Precedence is unchanged above it: an `onRowClick`
|
|
68
|
+
* takes the click first, and a supplied `onNavigate` wins over the published
|
|
69
|
+
* navigator, so every host that wires one (the grid's, the console's list
|
|
70
|
+
* views) behaves exactly as before. A host that publishes no navigator (the
|
|
71
|
+
* Studio preview, a bare React mount) has no record page to open, and the
|
|
72
|
+
* click still opens nothing: the context's documented absent state.
|
|
73
|
+
*
|
|
74
|
+
* ⚠️ Scoped to an AUTHORED block that resolves to `page`. An absent
|
|
75
|
+
* `navigation` stays the host's call (`onNavigate`, or nothing), and that is
|
|
76
|
+
* load-bearing rather than cautious: a host WITHHOLDS navigation by passing
|
|
77
|
+
* neither callback. `RelatedList` renders its mobile rows as an
|
|
78
|
+
* `object-gallery` with no `navigation` and an `onRowClick` that is undefined
|
|
79
|
+
* when the bridge withheld `onView`; reading the published navigator on the
|
|
80
|
+
* absent-key path would open those records anyway, under the very bridge that
|
|
81
|
+
* withheld them. So `{}` and no config still agree whenever an `onNavigate`
|
|
82
|
+
* is supplied, and part only where a host published a navigator but wired no
|
|
83
|
+
* callback. The kanban, calendar and gantt default an absent key to a drawer
|
|
84
|
+
* before it reaches this hook in any case. Modifier clicks and `new_window`
|
|
85
|
+
* are untouched as well. Pinned by
|
|
86
|
+
* `__tests__/useNavigationOverlay.hostRecordNavigator-11293.test.tsx` here and
|
|
87
|
+
* at the mounts by the kanban's and calendar's `NavigationMembers-8652` pins.
|
|
17
88
|
*/
|
|
18
89
|
import { useState, useCallback, useMemo } from 'react';
|
|
90
|
+
import { useRelatedRecordActions } from '../context/RelatedRecordActionsContext.js';
|
|
19
91
|
/**
|
|
20
92
|
* Pixel cap per overlay `size` bucket, clamped to the viewport at render —
|
|
21
93
|
* mirrors `plugin-view/src/recordSurface.ts` (`OVERLAY_SIZE_PX`), which owns
|
|
@@ -53,12 +125,36 @@ export function resolveOverlayWidth(navigation) {
|
|
|
53
125
|
/**
|
|
54
126
|
* Hook for NavigationConfig-driven navigation overlay.
|
|
55
127
|
*
|
|
128
|
+
* ## What to hand `objectName`
|
|
129
|
+
*
|
|
130
|
+
* The block's RECORD SOURCE — the object the clicked rows actually came from —
|
|
131
|
+
* and never a bare top-level `schema.objectName` read in its place. `77cb489b4`
|
|
132
|
+
* published `objectName` as the THIRD RUNG of one record-source ladder (`data`,
|
|
133
|
+
* then `staticData`, then `objectName`), not as a parallel "page object"
|
|
134
|
+
* concept, so a block has exactly ONE record source. `handleClick` below builds
|
|
135
|
+
* the record-page URL `/{objectName}/record/{id}` out of whatever it is handed:
|
|
136
|
+
* a caller that hands it the top-level key while its rows came from
|
|
137
|
+
* `data.object` navigates to a record that the URL's own object does not
|
|
138
|
+
* contain (`2ce2612df`).
|
|
139
|
+
*
|
|
140
|
+
* A caller that resolves a data config reads that ladder through the ONE shared
|
|
141
|
+
* reader — `resolveRecordSourceObjectName` from `@object-ui/core`
|
|
142
|
+
* (`b041b9c0c`) — as the example does. A caller with NO data config has
|
|
143
|
+
* nothing above rung three, and its `schema.objectName` already IS its record
|
|
144
|
+
* source; that spelling is correct there and needs no conversion.
|
|
145
|
+
*
|
|
56
146
|
* @example
|
|
57
147
|
* ```tsx
|
|
148
|
+
* import {
|
|
149
|
+
* resolveRecordSourceConfig,
|
|
150
|
+
* resolveRecordSourceObjectName,
|
|
151
|
+
* } from '@object-ui/core';
|
|
152
|
+
*
|
|
153
|
+
* const dataConfig = useMemo(() => resolveRecordSourceConfig(schema), [schema]);
|
|
58
154
|
* const { handleClick, isOpen, selectedRecord, mode, close, width } =
|
|
59
155
|
* useNavigationOverlay({
|
|
60
156
|
* navigation: schema.navigation,
|
|
61
|
-
* objectName: schema
|
|
157
|
+
* objectName: resolveRecordSourceObjectName(schema, dataConfig),
|
|
62
158
|
* onNavigate: schema.onNavigate,
|
|
63
159
|
* onRowClick: props.onRowClick,
|
|
64
160
|
* });
|
|
@@ -79,11 +175,13 @@ export function resolveOverlayWidth(navigation) {
|
|
|
79
175
|
*/
|
|
80
176
|
export function useNavigationOverlay(options) {
|
|
81
177
|
const { navigation, objectName, onNavigate, onRowClick } = options;
|
|
178
|
+
// The host's published record navigator — read for the `page` branch only,
|
|
179
|
+
// and only when no `onNavigate` was supplied (objectui#11293).
|
|
180
|
+
const openRecord = useRelatedRecordActions()?.openRecord;
|
|
82
181
|
const [isOpen, setIsOpen] = useState(false);
|
|
83
182
|
const [selectedRecord, setSelectedRecord] = useState(null);
|
|
84
183
|
const mode = navigation?.mode ?? 'page';
|
|
85
184
|
const width = resolveOverlayWidth(navigation);
|
|
86
|
-
const view = navigation?.view;
|
|
87
185
|
const isOverlay = mode === 'drawer' || mode === 'modal' || mode === 'split' || mode === 'popover';
|
|
88
186
|
const close = useCallback(() => {
|
|
89
187
|
setIsOpen(false);
|
|
@@ -97,6 +195,12 @@ export function useNavigationOverlay(options) {
|
|
|
97
195
|
// External onRowClick takes full priority. Forward the modifier event
|
|
98
196
|
// so parent handlers (e.g. ObjectView) can still implement Cmd/Ctrl/
|
|
99
197
|
// middle-click → open in new tab.
|
|
198
|
+
//
|
|
199
|
+
// Called straight through the declaration (objectui#9357). This used to
|
|
200
|
+
// carry a type assertion widening the option to two parameters at the
|
|
201
|
+
// call — the producer paying for its own understated declaration, which
|
|
202
|
+
// AGENTS.md #0.1 sends back to the producer. The producer is this file,
|
|
203
|
+
// and the option above now declares what this line passes.
|
|
100
204
|
if (onRowClick) {
|
|
101
205
|
onRowClick(record, event);
|
|
102
206
|
return;
|
|
@@ -117,7 +221,7 @@ export function useNavigationOverlay(options) {
|
|
|
117
221
|
if (!navigation) {
|
|
118
222
|
const recordId = record.id || record._id;
|
|
119
223
|
if (onNavigate && recordId != null) {
|
|
120
|
-
onNavigate(recordId,
|
|
224
|
+
onNavigate(recordId, 'view');
|
|
121
225
|
}
|
|
122
226
|
return;
|
|
123
227
|
}
|
|
@@ -143,11 +247,18 @@ export function useNavigationOverlay(options) {
|
|
|
143
247
|
window.open(url, '_blank');
|
|
144
248
|
return;
|
|
145
249
|
}
|
|
146
|
-
// page — delegate to onNavigate
|
|
250
|
+
// page — delegate to onNavigate; with none supplied, to the record
|
|
251
|
+
// navigator the host publishes (objectui#11293). No URL is built here.
|
|
147
252
|
if (mode === 'page') {
|
|
148
253
|
const recordId = record.id || record._id;
|
|
149
|
-
if (
|
|
150
|
-
|
|
254
|
+
if (recordId == null)
|
|
255
|
+
return;
|
|
256
|
+
if (onNavigate) {
|
|
257
|
+
onNavigate(recordId, 'view');
|
|
258
|
+
return;
|
|
259
|
+
}
|
|
260
|
+
if (objectName && openRecord) {
|
|
261
|
+
openRecord(objectName, recordId);
|
|
151
262
|
}
|
|
152
263
|
return;
|
|
153
264
|
}
|
|
@@ -157,7 +268,7 @@ export function useNavigationOverlay(options) {
|
|
|
157
268
|
setIsOpen(true);
|
|
158
269
|
return;
|
|
159
270
|
}
|
|
160
|
-
}, [onRowClick, navigation, mode, objectName, onNavigate,
|
|
271
|
+
}, [onRowClick, navigation, mode, objectName, onNavigate, openRecord, isOverlay]);
|
|
161
272
|
return useMemo(() => ({
|
|
162
273
|
isOpen,
|
|
163
274
|
selectedRecord,
|
|
@@ -167,7 +278,6 @@ export function useNavigationOverlay(options) {
|
|
|
167
278
|
setIsOpen,
|
|
168
279
|
handleClick,
|
|
169
280
|
width,
|
|
170
|
-
view,
|
|
171
281
|
isOverlay,
|
|
172
|
-
}), [isOpen, selectedRecord, mode, close, open, handleClick, width,
|
|
282
|
+
}), [isOpen, selectedRecord, mode, close, open, handleClick, width, isOverlay]);
|
|
173
283
|
}
|
package/dist/hooks/useOffline.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* This source code is licensed under the MIT license found in the
|
|
6
6
|
* LICENSE file in the root directory of this source tree.
|
|
7
7
|
*/
|
|
8
|
-
import { useCallback, useEffect, useMemo, useRef, useState, useSyncExternalStore } from 'react';
|
|
8
|
+
import { useCallback, useEffect, useInsertionEffect, useMemo, useRef, useState, useSyncExternalStore, } from 'react';
|
|
9
9
|
// ---------------------------------------------------------------------------
|
|
10
10
|
// Online/offline external store (SSR-safe)
|
|
11
11
|
// ---------------------------------------------------------------------------
|
|
@@ -93,7 +93,31 @@ export function useOffline(config = {}) {
|
|
|
93
93
|
const [queue, setQueue] = useState(loadQueue);
|
|
94
94
|
const [syncState, setSyncState] = useState('idle');
|
|
95
95
|
const syncConfigRef = useRef(syncConfig);
|
|
96
|
-
|
|
96
|
+
// `sync` below is keyed on `[enabled, queue]`, so a config-only change keeps
|
|
97
|
+
// the SAME `sync` closure alive — and the auto-sync effect deliberately
|
|
98
|
+
// captures one and fires it 100ms later. The ref is how those retained
|
|
99
|
+
// closures still read the newest `sync` config; putting `syncConfig` in
|
|
100
|
+
// `sync`'s deps instead would rebuild `sync` (and the memoised result) on
|
|
101
|
+
// every render, because callers pass `sync: { ... }` as an inline literal.
|
|
102
|
+
// Only the write moves out of the render body: `useInsertionEffect` runs in
|
|
103
|
+
// the mutation phase, ahead of every layout effect and paint, so no caller
|
|
104
|
+
// that could legally reach `sync()` observes a different value than before.
|
|
105
|
+
useInsertionEffect(() => {
|
|
106
|
+
syncConfigRef.current = syncConfig;
|
|
107
|
+
});
|
|
108
|
+
// The queue reaches `sync` through the SAME commit-phase mirror the sync
|
|
109
|
+
// config uses (objectui#6818). It used to come from `sync`'s own closure
|
|
110
|
+
// while `batchSize` came from the ref above, so the two halves of one call
|
|
111
|
+
// disagreed about how current they were: a retained `sync` — and the
|
|
112
|
+
// auto-sync effect below deliberately retains one and fires it 100ms later —
|
|
113
|
+
// batched a queue snapshot from an older render against the newest
|
|
114
|
+
// `batchSize`. Mirroring the queue makes both halves the newest COMMITTED
|
|
115
|
+
// value, and it is what takes `queue` out of `sync`'s dependency list, so
|
|
116
|
+
// `sync` stops changing identity on every queued mutation.
|
|
117
|
+
const queueRef = useRef(queue);
|
|
118
|
+
useInsertionEffect(() => {
|
|
119
|
+
queueRef.current = queue;
|
|
120
|
+
});
|
|
97
121
|
// Persist queue to localStorage whenever it changes
|
|
98
122
|
useEffect(() => {
|
|
99
123
|
persistQueue(queue);
|
|
@@ -130,14 +154,16 @@ export function useOffline(config = {}) {
|
|
|
130
154
|
setQueue([]);
|
|
131
155
|
}, []);
|
|
132
156
|
const sync = useCallback(async () => {
|
|
133
|
-
|
|
157
|
+
// Newest committed queue, not this closure's snapshot — see `queueRef`.
|
|
158
|
+
const pending = queueRef.current;
|
|
159
|
+
if (!enabled || pending.length === 0)
|
|
134
160
|
return;
|
|
135
161
|
setSyncState('syncing');
|
|
136
162
|
try {
|
|
137
163
|
// In a real implementation, this would batch-send mutations to the server.
|
|
138
164
|
// For now, we simulate a successful sync by clearing the queue.
|
|
139
|
-
const batchSize = syncConfigRef.current?.batchSize ??
|
|
140
|
-
const batch =
|
|
165
|
+
const batchSize = syncConfigRef.current?.batchSize ?? pending.length;
|
|
166
|
+
const batch = pending.slice(0, batchSize);
|
|
141
167
|
// Simulate network round-trip
|
|
142
168
|
await new Promise((resolve) => setTimeout(resolve, 0));
|
|
143
169
|
// Remove synced mutations from queue
|
|
@@ -147,18 +173,46 @@ export function useOffline(config = {}) {
|
|
|
147
173
|
catch {
|
|
148
174
|
setSyncState('error');
|
|
149
175
|
}
|
|
150
|
-
}, [enabled
|
|
151
|
-
// Auto-sync
|
|
176
|
+
}, [enabled]);
|
|
177
|
+
// Auto-sync while online and holding queued mutations (short stabilization
|
|
178
|
+
// delay).
|
|
179
|
+
//
|
|
180
|
+
// The dependency list used to be `[isOnline, enabled]` with
|
|
181
|
+
// `react-hooks/exhaustive-deps` suppressed, on the stated grounds that
|
|
182
|
+
// re-running "on every queue change" would restart the 100ms timer once per
|
|
183
|
+
// queued mutation. That reason is real and is preserved below — the
|
|
184
|
+
// dependency is the BOOLEAN `hasPendingMutations`, never `queue` and never
|
|
185
|
+
// `queue.length`, so queueing a second mutation while a timer is already
|
|
186
|
+
// armed does not re-run this effect and does not restart the timer.
|
|
187
|
+
//
|
|
188
|
+
// What the suppression also did, and never justified, was evaluate the
|
|
189
|
+
// emptiness guard against a queue snapshot from whenever `isOnline` or
|
|
190
|
+
// `enabled` last changed. `queueMutation` accepts entries whenever the hook
|
|
191
|
+
// is enabled — it has never been conditional on being offline — so anything
|
|
192
|
+
// queued while ALREADY online found this effect asleep and had no auto-sync
|
|
193
|
+
// path at all; only an explicit `sync()` drained it (objectui#6818). Keying
|
|
194
|
+
// on the boolean re-evaluates the guard exactly when it can change answer.
|
|
195
|
+
//
|
|
196
|
+
// `sync` is now stable across queue changes (it reads the queue through
|
|
197
|
+
// `queueRef`), so naming it here costs no extra timer restart and the array
|
|
198
|
+
// is genuinely exhaustive — the suppression is gone rather than reworded.
|
|
199
|
+
//
|
|
200
|
+
// Known remaining edge, deliberately not widened here: a `batchSize` smaller
|
|
201
|
+
// than the queue drains one batch and leaves `hasPendingMutations` true, so
|
|
202
|
+
// the remainder waits for the next transition rather than chaining a second
|
|
203
|
+
// batch. That is the pre-existing behaviour, not a regression. Whether one
|
|
204
|
+
// auto-sync should drain the whole queue batch-by-batch is a semantics
|
|
205
|
+
// question about `batchSize` rather than a bug in this guard, and it is
|
|
206
|
+
// filed separately as objectui#6857.
|
|
207
|
+
const hasPendingMutations = queue.length > 0;
|
|
152
208
|
useEffect(() => {
|
|
153
|
-
if (!enabled || !isOnline ||
|
|
209
|
+
if (!enabled || !isOnline || !hasPendingMutations)
|
|
154
210
|
return;
|
|
155
211
|
const timer = setTimeout(() => {
|
|
156
212
|
void sync();
|
|
157
213
|
}, 100);
|
|
158
214
|
return () => clearTimeout(timer);
|
|
159
|
-
|
|
160
|
-
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
161
|
-
}, [isOnline, enabled]);
|
|
215
|
+
}, [isOnline, enabled, hasPendingMutations, sync]);
|
|
162
216
|
return useMemo(() => ({
|
|
163
217
|
isOnline,
|
|
164
218
|
enabled,
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
*
|
|
8
8
|
* `usePageAssignment` — resolve the record PageSchema that should be rendered
|
|
9
9
|
* for a given object. Walks the metadata cache exposed by `<MetadataProvider>`
|
|
10
|
-
* and returns the first PageSchema whose `
|
|
10
|
+
* and returns the first PageSchema whose `type === 'record'` and `object`
|
|
11
11
|
* matches the requested name.
|
|
12
12
|
*
|
|
13
13
|
* Returns a discriminated result by `PageSchema.kind`:
|
|
@@ -18,10 +18,13 @@
|
|
|
18
18
|
* `buildDefaultPageSchema(objectDef, { slots })` so omitted slots
|
|
19
19
|
* fall through to synthesized defaults.
|
|
20
20
|
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
21
|
+
* Selection is by DECLARATION ORDER: the first matching page wins, so callers
|
|
22
|
+
* can deterministically fall back to the auto-generated DetailView when no
|
|
23
|
+
* record Page is authored.
|
|
24
|
+
*
|
|
25
|
+
* Future work (deferred): recordType / profile / app / formFactor filtering.
|
|
26
|
+
* Any author-driven ordering would have to be DECLARED on `PageSchema` in
|
|
27
|
+
* `@objectstack/spec` first — see the note on the selection itself below.
|
|
25
28
|
*/
|
|
26
29
|
export interface PageAssignmentOptions {
|
|
27
30
|
/** Salesforce-style record type filter (reserved for future use). */
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
*
|
|
8
8
|
* `usePageAssignment` — resolve the record PageSchema that should be rendered
|
|
9
9
|
* for a given object. Walks the metadata cache exposed by `<MetadataProvider>`
|
|
10
|
-
* and returns the first PageSchema whose `
|
|
10
|
+
* and returns the first PageSchema whose `type === 'record'` and `object`
|
|
11
11
|
* matches the requested name.
|
|
12
12
|
*
|
|
13
13
|
* Returns a discriminated result by `PageSchema.kind`:
|
|
@@ -18,10 +18,13 @@
|
|
|
18
18
|
* `buildDefaultPageSchema(objectDef, { slots })` so omitted slots
|
|
19
19
|
* fall through to synthesized defaults.
|
|
20
20
|
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
21
|
+
* Selection is by DECLARATION ORDER: the first matching page wins, so callers
|
|
22
|
+
* can deterministically fall back to the auto-generated DetailView when no
|
|
23
|
+
* record Page is authored.
|
|
24
|
+
*
|
|
25
|
+
* Future work (deferred): recordType / profile / app / formFactor filtering.
|
|
26
|
+
* Any author-driven ordering would have to be DECLARED on `PageSchema` in
|
|
27
|
+
* `@objectstack/spec` first — see the note on the selection itself below.
|
|
25
28
|
*/
|
|
26
29
|
import { useEffect, useMemo, useState } from 'react';
|
|
27
30
|
import { useMetadata } from '../context/AppShellContext.js';
|
|
@@ -75,14 +78,20 @@ export function usePageAssignment(objectName, opts = {}) {
|
|
|
75
78
|
const candidates = pages.filter(p => {
|
|
76
79
|
if (!p)
|
|
77
80
|
return false;
|
|
78
|
-
//
|
|
79
|
-
// user-facing record-detail page
|
|
80
|
-
//
|
|
81
|
-
//
|
|
82
|
-
//
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
81
|
+
// `type` is the ONE discriminator: only `type: 'record'` is a
|
|
82
|
+
// user-facing record-detail page, and every other page type
|
|
83
|
+
// (`home` / `app` / `utility` / `list`) is skipped.
|
|
84
|
+
//
|
|
85
|
+
// `pageType` is deliberately NOT read (objectui#9674). `PageSchema` is
|
|
86
|
+
// a `strictObject` that refuses `pageType` by name — it is a declared
|
|
87
|
+
// ALIAS of `type`, and a page carrying it is a hard parse error that
|
|
88
|
+
// names `type` as the key to write — so no page that parses carries it,
|
|
89
|
+
// and reading it would teach the refused spelling onward. A consumer-side
|
|
90
|
+
// alias for a refused key is the fallback AGENTS.md #0.1 rules out. The
|
|
91
|
+
// designer-side `'record_detail'` is not expressible either: it left
|
|
92
|
+
// `PageTypeSchema` (framework#2265), so `type: 'record_detail'` is an
|
|
93
|
+
// invalid enum value.
|
|
94
|
+
if (p.type !== 'record')
|
|
86
95
|
return false;
|
|
87
96
|
if (p.object !== objectName)
|
|
88
97
|
return false;
|
|
@@ -90,9 +99,21 @@ export function usePageAssignment(objectName, opts = {}) {
|
|
|
90
99
|
});
|
|
91
100
|
if (!candidates.length)
|
|
92
101
|
return null;
|
|
93
|
-
//
|
|
94
|
-
//
|
|
95
|
-
|
|
102
|
+
// Declaration order decides: the first match wins.
|
|
103
|
+
//
|
|
104
|
+
// This used to sort on a `priority` key read off the candidate. No author
|
|
105
|
+
// could ever set it: `PageSchema` is a `strictObject` and does not declare
|
|
106
|
+
// `priority`, so a page carrying one is a HARD PARSE ERROR, not a page that
|
|
107
|
+
// sorts first. Every candidate therefore read `0`, the comparator returned
|
|
108
|
+
// `0` for every pair, and a stable sort left declaration order untouched —
|
|
109
|
+
// the sort documented an affordance the schema refuses (objectui#7298).
|
|
110
|
+
//
|
|
111
|
+
// `isDefault` is not consulted here either. It IS declared on `PageSchema`,
|
|
112
|
+
// so unlike `priority` it is writable — but nothing in this decision reads
|
|
113
|
+
// it, which makes the flag on a shipped page (e.g. the platform's
|
|
114
|
+
// `sys_user_detail`) inert while looking decisive. Reading it would be new
|
|
115
|
+
// behaviour, not a repair; it is recorded here so the next reader does not
|
|
116
|
+
// mistake the flag for the thing that picks the page.
|
|
96
117
|
return candidates[0];
|
|
97
118
|
}, [meta.pages, objectName, opts.pageName, opts.recordType, opts.profile, opts.app, opts.formFactor]);
|
|
98
119
|
// Discriminate by `kind`: full pages populate `page`, slotted pages
|
|
@@ -23,7 +23,10 @@ export interface RecordSearchHit {
|
|
|
23
23
|
* objects. Stable across runs for the same (query, display) pair.
|
|
24
24
|
*/
|
|
25
25
|
score: number;
|
|
26
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* Raw record payload, for callers that want extra context. It is the row as
|
|
28
|
+
* served: `fieldReadPolicy` gates the `display` label, not this payload.
|
|
29
|
+
*/
|
|
27
30
|
raw: any;
|
|
28
31
|
}
|
|
29
32
|
export interface UseRecordSearchOptions {
|
|
@@ -60,8 +63,38 @@ export interface UseRecordSearchOptions {
|
|
|
60
63
|
* Optional display-name resolver. Defaults to the same `titleFormat`
|
|
61
64
|
* fallback chain used by app-shell. Pass `getRecordDisplayName` from
|
|
62
65
|
* `@object-ui/app-shell` to share that implementation exactly.
|
|
66
|
+
*
|
|
67
|
+
* Safe to pass inline: the resolver's identity never re-runs the search.
|
|
68
|
+
* Each run reads the resolver of the latest render, so a swapped resolver
|
|
69
|
+
* labels the hits of the next run; results already shown keep their labels.
|
|
63
70
|
*/
|
|
64
71
|
getDisplayName?: (objectDef: any, record: any) => string;
|
|
72
|
+
/**
|
|
73
|
+
* Optional field-level read policy: pass `usePermissions()` from
|
|
74
|
+
* `@object-ui/permissions` (objectui#10500). Once it is loaded, a hit is
|
|
75
|
+
* labelled from its record with the fields the policy denies on the hit's
|
|
76
|
+
* object removed, `id` and `_id` kept. The row is gated BEFORE
|
|
77
|
+
* `getDisplayName` reads it, so a caller-supplied resolver is gated too. A
|
|
78
|
+
* denied field then reads exactly as an absent one and the resolver falls
|
|
79
|
+
* through to its next rung, the label a backend that strips denied fields
|
|
80
|
+
* (ObjectStack's `FieldMasker`) already yields. The rule is
|
|
81
|
+
* `withoutDeniedFields` from `@object-ui/core` (objectui#10594), the one the
|
|
82
|
+
* record title (objectui#10434) and the lookup option label (objectui#10411)
|
|
83
|
+
* call too.
|
|
84
|
+
*
|
|
85
|
+
* Omitted, or not loaded yet, the row is labelled as served. A title the
|
|
86
|
+
* server computed (`searchAll`'s `hit.title`) is the server's answer and is
|
|
87
|
+
* not re-judged here.
|
|
88
|
+
*
|
|
89
|
+
* Safe to pass inline: only `isLoaded` decides whether a run happens. When
|
|
90
|
+
* it changes the search re-runs, so hits labelled before the policy loaded
|
|
91
|
+
* are relabelled from the gated row. Otherwise each run reads the policy of
|
|
92
|
+
* the latest render, as it does `getDisplayName`.
|
|
93
|
+
*/
|
|
94
|
+
fieldReadPolicy?: {
|
|
95
|
+
isLoaded: boolean;
|
|
96
|
+
checkField: (object: string, field: string, action: 'read') => boolean;
|
|
97
|
+
};
|
|
65
98
|
}
|
|
66
99
|
export interface UseRecordSearchResult {
|
|
67
100
|
results: RecordSearchHit[];
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* LICENSE file in the root directory of this source tree.
|
|
7
7
|
*/
|
|
8
8
|
import { useEffect, useMemo, useRef, useState } from 'react';
|
|
9
|
-
import { getRecordDisplayName as defaultDisplayName } from '@object-ui/core';
|
|
9
|
+
import { getRecordDisplayName as defaultDisplayName, withoutDeniedFields } from '@object-ui/core';
|
|
10
10
|
import { errorCodeIs } from '@object-ui/types';
|
|
11
11
|
// ADR-0079: the global-search default display-name resolver is now the ONE
|
|
12
12
|
// shared `getRecordDisplayName` from `@object-ui/core` (honors titleFormat →
|
|
@@ -74,7 +74,10 @@ function scoreHit(query, display, recordId) {
|
|
|
74
74
|
* `$filter` translation.
|
|
75
75
|
*/
|
|
76
76
|
export function useRecordSearch(opts) {
|
|
77
|
-
const { query, objects, dataSource, objectNames, maxObjectsQueried = 8, topPerObject = 3, minLength = 2, debounceMs = 250, enabled = true, getDisplayName = defaultDisplayName, } = opts;
|
|
77
|
+
const { query, objects, dataSource, objectNames, maxObjectsQueried = 8, topPerObject = 3, minLength = 2, debounceMs = 250, enabled = true, getDisplayName = defaultDisplayName, fieldReadPolicy, } = opts;
|
|
78
|
+
// The one member of the read policy that decides whether a run happens: a
|
|
79
|
+
// primitive, so an inline policy object never re-runs the search by identity.
|
|
80
|
+
const policyLoaded = fieldReadPolicy?.isLoaded === true;
|
|
78
81
|
const [results, setResults] = useState([]);
|
|
79
82
|
const [isSearching, setIsSearching] = useState(false);
|
|
80
83
|
const [error, setError] = useState(undefined);
|
|
@@ -111,11 +114,41 @@ export function useRecordSearch(opts) {
|
|
|
111
114
|
}
|
|
112
115
|
return pool;
|
|
113
116
|
}, [objects, objectNames]);
|
|
117
|
+
// The object NAME is the whole signature: it is the only field of an object
|
|
118
|
+
// definition this effect consumes (`dataSource.find(obj.name, …)` and the
|
|
119
|
+
// `objects` whitelist sent to `searchAll`); `label` / `icon` are read per hit
|
|
120
|
+
// at render time and never decide whether the fanout re-runs.
|
|
121
|
+
//
|
|
122
|
+
// An `o?.titleField ?? ''` half used to be appended to each entry. It could
|
|
123
|
+
// never vary: `@objectstack/spec`'s object schema is a `strictObject` that
|
|
124
|
+
// REJECTS `titleField` with `unrecognized_keys` (objectui#6531), so no legal
|
|
125
|
+
// object metadata carries it and the half was permanently `''` — a constant
|
|
126
|
+
// suffix in a cache key, which also read as evidence that some producer ships
|
|
127
|
+
// the key. Removed in objectui#6557; the display name comes from
|
|
128
|
+
// `getRecordDisplayName`, which does not consult it either.
|
|
114
129
|
const candidateSignature = useMemo(() => {
|
|
115
|
-
return candidates.map((o) =>
|
|
130
|
+
return candidates.map((o) => String(o?.name)).join('|');
|
|
116
131
|
}, [candidates]);
|
|
117
132
|
// Run ID for racing-request guarding. Stable across renders.
|
|
118
133
|
const runIdRef = useRef(0);
|
|
134
|
+
// `getDisplayName` is caller-supplied and read only INSIDE a run, to label
|
|
135
|
+
// hits — it never decides whether a run happens. So the search effect reads
|
|
136
|
+
// the latest resolver through this ref and does not key on its identity
|
|
137
|
+
// (AGENTS.md §5 #10, objectui#10044). Keyed on it, an inline resolver (a new
|
|
138
|
+
// function every render) re-ran the effect on each render, and the cleanup
|
|
139
|
+
// cleared the pending debounce timer: renders faster than `debounceMs` never
|
|
140
|
+
// searched, and sparser renders issued a second identical request. Declared
|
|
141
|
+
// before the search effect, so it is current before any timer is armed.
|
|
142
|
+
//
|
|
143
|
+
// `fieldReadPolicy` is read the same way (objectui#10500): the run reads the
|
|
144
|
+
// latest policy through a ref, and only its `isLoaded` primitive
|
|
145
|
+
// (`policyLoaded`) is a dependency of the search effect.
|
|
146
|
+
const getDisplayNameRef = useRef(getDisplayName);
|
|
147
|
+
const fieldReadPolicyRef = useRef(fieldReadPolicy);
|
|
148
|
+
useEffect(() => {
|
|
149
|
+
getDisplayNameRef.current = getDisplayName;
|
|
150
|
+
fieldReadPolicyRef.current = fieldReadPolicy;
|
|
151
|
+
});
|
|
119
152
|
useEffect(() => {
|
|
120
153
|
if (!enabled || !dataSource || candidates.length === 0) {
|
|
121
154
|
setResults([]);
|
|
@@ -142,7 +175,7 @@ export function useRecordSearch(opts) {
|
|
|
142
175
|
// per-object `find({ $search })` fanout below only runs each object's
|
|
143
176
|
// metadata-driven search (ADR-0061) and can miss records the global
|
|
144
177
|
// search index knows about — the command-palette symptom in framework
|
|
145
|
-
// #3371, where `/api/v1/search` returned an account/opportunity the
|
|
178
|
+
// objectstack-ai/objectstack#3371, where `/api/v1/search` returned an account/opportunity the
|
|
146
179
|
// palette never showed. When `searchAll` is absent (mock/test adapters,
|
|
147
180
|
// non-ObjectStack backends) we fall back to the fanout.
|
|
148
181
|
const searchAll = dataSource.searchAll;
|
|
@@ -184,7 +217,9 @@ export function useRecordSearch(opts) {
|
|
|
184
217
|
continue;
|
|
185
218
|
const objDef = byName.get(objectName) ?? { name: objectName };
|
|
186
219
|
const title = typeof h?.title === 'string' && h.title.trim() !== '' ? h.title.trim() : '';
|
|
187
|
-
const display = title ||
|
|
220
|
+
const display = title ||
|
|
221
|
+
getDisplayNameRef.current(objDef, withoutDeniedFields(h?.record ?? {}, fieldReadPolicyRef.current, objectName)) ||
|
|
222
|
+
`Record #${recordId}`;
|
|
188
223
|
const snippet = typeof h?.snippet === 'string' ? h.snippet.trim() : '';
|
|
189
224
|
hits.push({
|
|
190
225
|
objectName,
|
|
@@ -256,7 +291,7 @@ export function useRecordSearch(opts) {
|
|
|
256
291
|
const recordId = record?.id ?? record?._id;
|
|
257
292
|
if (recordId == null)
|
|
258
293
|
continue;
|
|
259
|
-
const display =
|
|
294
|
+
const display = getDisplayNameRef.current(obj, withoutDeniedFields(record, fieldReadPolicyRef.current, obj.name));
|
|
260
295
|
hits.push({
|
|
261
296
|
objectName: obj.name,
|
|
262
297
|
objectLabel: typeof obj.label === 'string' && obj.label.length > 0
|
|
@@ -290,7 +325,7 @@ export function useRecordSearch(opts) {
|
|
|
290
325
|
maxObjectsQueried,
|
|
291
326
|
minLength,
|
|
292
327
|
debounceMs,
|
|
293
|
-
|
|
328
|
+
policyLoaded,
|
|
294
329
|
]);
|
|
295
330
|
return { results, isSearching, error };
|
|
296
331
|
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ObjectUI
|
|
3
|
+
* Copyright (c) 2024-present ObjectStack Inc.
|
|
4
|
+
*
|
|
5
|
+
* This source code is licensed under the MIT license found in the
|
|
6
|
+
* LICENSE file in the root directory of this source tree.
|
|
7
|
+
*/
|
|
8
|
+
import { type FilterTokenScope } from '@object-ui/core';
|
|
9
|
+
/**
|
|
10
|
+
* Resolve a data node's own authored `filter` ONCE, and hold the result.
|
|
11
|
+
*
|
|
12
|
+
* Every context token the spec defines for filters (`{current_user_id}`,
|
|
13
|
+
* `{current_org_id}`, `{record_id}` where a record is in view, and the date
|
|
14
|
+
* macros such as `{today}`) is expanded by `@object-ui/core`'s shared
|
|
15
|
+
* `resolveFilterPlaceholders`, against the scope `useFilterScope()` reads: the
|
|
16
|
+
* session scope the host provides plus the mounted record's id
|
|
17
|
+
* (objectui#7297). Pass `useFilterScope()` as `scope`:
|
|
18
|
+
*
|
|
19
|
+
* ```tsx
|
|
20
|
+
* const filterScope = useFilterScope();
|
|
21
|
+
* const filter = useResolvedFilter(schema.filter, filterScope);
|
|
22
|
+
* // query with `filter`, and key the fetch effect on `filter`, never on schema.filter
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* ⛔ Not a second resolver, and no fallback: a token the scope cannot resolve
|
|
26
|
+
* is whatever `resolveFilterPlaceholders` makes of it (left intact, with one
|
|
27
|
+
* warning naming it).
|
|
28
|
+
*
|
|
29
|
+
* The result is HELD against its inputs, the shape `plugin-view`'s
|
|
30
|
+
* `useResolvedFilterSegments` uses. A fetch effect keys on this filter, so a
|
|
31
|
+
* resolved copy minted on every render would refetch on every render; and a
|
|
32
|
+
* date macro such as `{now}` resolves to a new value at every call, so
|
|
33
|
+
* comparing OUTPUTS cannot stop that. The key is the authored filter, compared
|
|
34
|
+
* by structure (a host that rebuilds an equal filter inline must not
|
|
35
|
+
* re-query), plus each scope member read one by one (`recordId` among them,
|
|
36
|
+
* so moving to another record resolves again), never the scope object's
|
|
37
|
+
* identity (AGENTS.md #10). The held pair lives in state, so the
|
|
38
|
+
* value handed out is always the one React committed. A structurally different
|
|
39
|
+
* filter, or a changed scope member, resolves again and hands out a new value.
|
|
40
|
+
*
|
|
41
|
+
* A filter the resolver leaves unchanged (no token, or only tokens the scope
|
|
42
|
+
* cannot resolve) is handed out as the authored value itself, not as the
|
|
43
|
+
* resolver's equal copy, so a token-free filter reaches the query exactly as
|
|
44
|
+
* it did before any resolution.
|
|
45
|
+
*/
|
|
46
|
+
export declare function useResolvedFilter<T>(authored: T, scope: FilterTokenScope): T;
|