@object-ui/react 3.0.3 → 3.1.1
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/.turbo/turbo-build.log +1 -1
- package/CHANGELOG.md +9 -0
- package/dist/SchemaRenderer.js +61 -2
- package/dist/context/SchemaRendererContext.d.ts +4 -1
- package/dist/context/SchemaRendererContext.js +6 -4
- package/dist/hooks/index.d.ts +3 -0
- package/dist/hooks/index.js +3 -0
- package/dist/hooks/useActionEngine.d.ts +27 -0
- package/dist/hooks/useActionEngine.js +39 -0
- package/dist/hooks/useDebugMode.d.ts +43 -0
- package/dist/hooks/useDebugMode.js +71 -0
- package/dist/hooks/useGlobalUndo.d.ts +35 -0
- package/dist/hooks/useGlobalUndo.js +86 -0
- package/dist/hooks/useNavigationOverlay.d.ts +2 -0
- package/dist/hooks/useNavigationOverlay.js +12 -5
- package/dist/index.d.ts +3 -1
- package/dist/index.js +4 -1
- package/dist/spec-bridge/SpecBridge.d.ts +26 -0
- package/dist/spec-bridge/SpecBridge.js +62 -0
- package/dist/spec-bridge/bridges/dashboard.d.ts +81 -0
- package/dist/spec-bridge/bridges/dashboard.js +121 -0
- package/dist/spec-bridge/bridges/form-view.d.ts +44 -0
- package/dist/spec-bridge/bridges/form-view.js +77 -0
- package/dist/spec-bridge/bridges/list-view.d.ts +82 -0
- package/dist/spec-bridge/bridges/list-view.js +154 -0
- package/dist/spec-bridge/bridges/page.d.ts +68 -0
- package/dist/spec-bridge/bridges/page.js +81 -0
- package/dist/spec-bridge/index.d.ts +13 -0
- package/dist/spec-bridge/index.js +12 -0
- package/dist/spec-bridge/types.d.ts +34 -0
- package/dist/spec-bridge/types.js +8 -0
- package/package.json +9 -8
- package/src/SchemaRenderer.tsx +66 -0
- package/src/__tests__/LazyPluginLoader.test.tsx +1 -1
- package/src/__tests__/SchemaRenderer.debug.test.tsx +69 -0
- package/src/__tests__/SchemaRenderer.expressions.test.tsx +131 -0
- package/src/__tests__/useNavigationOverlay.test.ts +162 -0
- package/src/context/SchemaRendererContext.tsx +9 -4
- package/src/context/__tests__/useDataScope.test.tsx +91 -0
- package/src/hooks/__tests__/useActionEngine.test.ts +170 -0
- package/src/hooks/__tests__/useCrudShortcuts.test.ts +85 -0
- package/src/hooks/__tests__/useDebugMode.test.ts +83 -0
- package/src/hooks/__tests__/useFocusTrap.test.ts +247 -0
- package/src/hooks/__tests__/usePageTransition.test.ts +158 -0
- package/src/hooks/__tests__/useReducedMotion.test.ts +104 -0
- package/src/hooks/index.ts +3 -0
- package/src/hooks/useActionEngine.ts +84 -0
- package/src/hooks/useDebugMode.ts +95 -0
- package/src/hooks/useGlobalUndo.ts +98 -0
- package/src/hooks/useNavigationOverlay.ts +14 -5
- package/src/index.ts +6 -0
- package/src/spec-bridge/SpecBridge.ts +64 -0
- package/src/spec-bridge/__tests__/P1SpecBridge.test.ts +855 -0
- package/src/spec-bridge/__tests__/SpecBridge.test.ts +550 -0
- package/src/spec-bridge/bridges/dashboard.ts +180 -0
- package/src/spec-bridge/bridges/form-view.ts +109 -0
- package/src/spec-bridge/bridges/list-view.ts +187 -0
- package/src/spec-bridge/bridges/page.ts +136 -0
- package/src/spec-bridge/index.ts +14 -0
- package/src/spec-bridge/types.ts +38 -0
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -0,0 +1,13 @@
|
|
|
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
|
+
export { SpecBridge } from './SpecBridge';
|
|
9
|
+
export type { BridgeContext, BridgeFn, ObjectDefLite } from './types';
|
|
10
|
+
export { bridgeListView } from './bridges/list-view';
|
|
11
|
+
export { bridgeFormView } from './bridges/form-view';
|
|
12
|
+
export { bridgePage } from './bridges/page';
|
|
13
|
+
export { bridgeDashboard } from './bridges/dashboard';
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
export { SpecBridge } from './SpecBridge';
|
|
9
|
+
export { bridgeListView } from './bridges/list-view';
|
|
10
|
+
export { bridgeFormView } from './bridges/form-view';
|
|
11
|
+
export { bridgePage } from './bridges/page';
|
|
12
|
+
export { bridgeDashboard } from './bridges/dashboard';
|
|
@@ -0,0 +1,34 @@
|
|
|
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 { SchemaNode } from '@object-ui/core';
|
|
9
|
+
/** Context passed to all bridge functions */
|
|
10
|
+
export interface BridgeContext {
|
|
11
|
+
/** Current user context for permission checks */
|
|
12
|
+
user?: Record<string, any>;
|
|
13
|
+
/** App-level variables */
|
|
14
|
+
variables?: Record<string, any>;
|
|
15
|
+
/** Registered object definitions for field metadata lookup */
|
|
16
|
+
objectDefs?: Record<string, ObjectDefLite>;
|
|
17
|
+
}
|
|
18
|
+
/** Lightweight object definition for field metadata resolution */
|
|
19
|
+
export interface ObjectDefLite {
|
|
20
|
+
name: string;
|
|
21
|
+
label?: string;
|
|
22
|
+
fields: Array<{
|
|
23
|
+
name: string;
|
|
24
|
+
label?: string;
|
|
25
|
+
type: string;
|
|
26
|
+
required?: boolean;
|
|
27
|
+
options?: Array<{
|
|
28
|
+
label: string;
|
|
29
|
+
value: string;
|
|
30
|
+
}>;
|
|
31
|
+
}>;
|
|
32
|
+
}
|
|
33
|
+
/** A bridge function transforms a spec schema into a SchemaNode tree */
|
|
34
|
+
export type BridgeFn<T = any> = (spec: T, context: BridgeContext) => SchemaNode;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@object-ui/react",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.1.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "React bindings and SchemaRenderer component for Object UI",
|
|
@@ -19,22 +19,23 @@
|
|
|
19
19
|
"exports": {
|
|
20
20
|
".": {
|
|
21
21
|
"types": "./dist/index.d.ts",
|
|
22
|
-
"import": "./dist/index.js"
|
|
22
|
+
"import": "./dist/index.js",
|
|
23
|
+
"default": "./dist/index.js"
|
|
23
24
|
}
|
|
24
25
|
},
|
|
25
26
|
"dependencies": {
|
|
26
|
-
"@objectstack/spec": "^3.
|
|
27
|
-
"react-hook-form": "^7.71.
|
|
28
|
-
"@object-ui/core": "3.
|
|
29
|
-
"@object-ui/i18n": "3.
|
|
30
|
-
"@object-ui/types": "3.
|
|
27
|
+
"@objectstack/spec": "^3.2.1",
|
|
28
|
+
"react-hook-form": "^7.71.2",
|
|
29
|
+
"@object-ui/core": "3.1.1",
|
|
30
|
+
"@object-ui/i18n": "3.1.1",
|
|
31
|
+
"@object-ui/types": "3.1.1"
|
|
31
32
|
},
|
|
32
33
|
"peerDependencies": {
|
|
33
34
|
"react": "^18.0.0 || ^19.0.0",
|
|
34
35
|
"react-dom": "^18.0.0 || ^19.0.0"
|
|
35
36
|
},
|
|
36
37
|
"devDependencies": {
|
|
37
|
-
"@types/react": "19.2.
|
|
38
|
+
"@types/react": "19.2.14",
|
|
38
39
|
"@types/react-dom": "19.2.3",
|
|
39
40
|
"typescript": "^5.9.3"
|
|
40
41
|
},
|
package/src/SchemaRenderer.tsx
CHANGED
|
@@ -17,6 +17,7 @@ import {
|
|
|
17
17
|
debugLog,
|
|
18
18
|
debugTime,
|
|
19
19
|
debugTimeEnd,
|
|
20
|
+
DebugCollector,
|
|
20
21
|
} from '@object-ui/core';
|
|
21
22
|
import { SchemaRendererContext } from './context/SchemaRendererContext';
|
|
22
23
|
import { resolveI18nLabel } from './utils/i18n';
|
|
@@ -133,10 +134,48 @@ export const SchemaRenderer = forwardRef<any, { schema: SchemaNode } & Record<st
|
|
|
133
134
|
newSchema.props = newProps;
|
|
134
135
|
}
|
|
135
136
|
|
|
137
|
+
// Evaluate visibility: visible / visibleOn / hidden / hiddenOn
|
|
138
|
+
const shouldHide = (() => {
|
|
139
|
+
if (newSchema.visible !== undefined) {
|
|
140
|
+
return !evaluator.evaluateCondition(newSchema.visible);
|
|
141
|
+
}
|
|
142
|
+
if (newSchema.visibleOn !== undefined) {
|
|
143
|
+
return !evaluator.evaluateCondition(newSchema.visibleOn);
|
|
144
|
+
}
|
|
145
|
+
if (newSchema.hidden !== undefined) {
|
|
146
|
+
return evaluator.evaluateCondition(newSchema.hidden);
|
|
147
|
+
}
|
|
148
|
+
if (newSchema.hiddenOn !== undefined) {
|
|
149
|
+
return evaluator.evaluateCondition(newSchema.hiddenOn);
|
|
150
|
+
}
|
|
151
|
+
return false;
|
|
152
|
+
})();
|
|
153
|
+
|
|
154
|
+
if (shouldHide) {
|
|
155
|
+
newSchema._hidden = true;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
// Evaluate disabled: disabled / disabledOn
|
|
159
|
+
const isDisabled = (() => {
|
|
160
|
+
if (newSchema.disabled !== undefined) {
|
|
161
|
+
return evaluator.evaluateCondition(newSchema.disabled);
|
|
162
|
+
}
|
|
163
|
+
if (newSchema.disabledOn !== undefined) {
|
|
164
|
+
return evaluator.evaluateCondition(newSchema.disabledOn);
|
|
165
|
+
}
|
|
166
|
+
return false;
|
|
167
|
+
})();
|
|
168
|
+
|
|
169
|
+
if (isDisabled) {
|
|
170
|
+
newSchema._disabled = true;
|
|
171
|
+
}
|
|
172
|
+
|
|
136
173
|
return newSchema;
|
|
137
174
|
}, [schema, dataSource]);
|
|
138
175
|
|
|
139
176
|
if (!evaluatedSchema) return null;
|
|
177
|
+
// Handle visibility: if evaluated schema is hidden, render nothing
|
|
178
|
+
if (evaluatedSchema?._hidden) return null;
|
|
140
179
|
// If schema is just a string, render it as text
|
|
141
180
|
if (typeof evaluatedSchema === 'string') return <>{evaluatedSchema}</>;
|
|
142
181
|
|
|
@@ -173,13 +212,26 @@ export const SchemaRenderer = forwardRef<any, { schema: SchemaNode } & Record<st
|
|
|
173
212
|
hiddenOn: _hiddenOn,
|
|
174
213
|
disabled: _disabled,
|
|
175
214
|
disabledOn: _disabledOn,
|
|
215
|
+
_hidden: __hidden, // stripped: internal visibility flag
|
|
216
|
+
_disabled: __disabled, // stripped: internal disabled flag
|
|
176
217
|
...componentProps
|
|
177
218
|
} = evaluatedSchema;
|
|
178
219
|
|
|
179
220
|
// Extract AriaPropsSchema properties for accessibility
|
|
180
221
|
const ariaProps = resolveAriaProps(evaluatedSchema);
|
|
181
222
|
|
|
223
|
+
// Debug-mode enhancements: extra data attributes + perf tracking
|
|
224
|
+
const isDebug = context?.debug || context?.debugFlags?.enabled;
|
|
225
|
+
const debugAttrs: Record<string, string> = {};
|
|
226
|
+
if (isDebug) {
|
|
227
|
+
debugAttrs['data-debug-type'] = evaluatedSchema.type;
|
|
228
|
+
if (evaluatedSchema.id) {
|
|
229
|
+
debugAttrs['data-debug-id'] = evaluatedSchema.id;
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
|
|
182
233
|
debugTime(`render:${evaluatedSchema.type}:${evaluatedSchema.id ?? 'anon'}`);
|
|
234
|
+
const renderStart = isDebug ? performance.now() : 0;
|
|
183
235
|
const rendered = (
|
|
184
236
|
<SchemaErrorBoundary componentType={evaluatedSchema.type}>
|
|
185
237
|
{React.createElement(Component, {
|
|
@@ -187,6 +239,8 @@ export const SchemaRenderer = forwardRef<any, { schema: SchemaNode } & Record<st
|
|
|
187
239
|
...componentProps, // Spread non-metadata schema properties as props
|
|
188
240
|
...(evaluatedSchema.props || {}), // Override with explicit props if provided
|
|
189
241
|
...ariaProps, // Inject ARIA attributes from AriaPropsSchema
|
|
242
|
+
...debugAttrs, // Debug-mode data attributes
|
|
243
|
+
disabled: __disabled || undefined,
|
|
190
244
|
className: evaluatedSchema.className,
|
|
191
245
|
'data-obj-id': evaluatedSchema.id,
|
|
192
246
|
'data-obj-type': evaluatedSchema.type,
|
|
@@ -195,6 +249,18 @@ export const SchemaRenderer = forwardRef<any, { schema: SchemaNode } & Record<st
|
|
|
195
249
|
</SchemaErrorBoundary>
|
|
196
250
|
);
|
|
197
251
|
debugTimeEnd(`render:${evaluatedSchema.type}:${evaluatedSchema.id ?? 'anon'}`);
|
|
252
|
+
|
|
253
|
+
// Report render perf to DebugCollector when debug mode is active
|
|
254
|
+
if (isDebug && renderStart) {
|
|
255
|
+
const durationMs = performance.now() - renderStart;
|
|
256
|
+
DebugCollector.getInstance().addPerf({
|
|
257
|
+
type: evaluatedSchema.type,
|
|
258
|
+
id: evaluatedSchema.id,
|
|
259
|
+
durationMs,
|
|
260
|
+
timestamp: Date.now(),
|
|
261
|
+
});
|
|
262
|
+
}
|
|
263
|
+
|
|
198
264
|
return rendered;
|
|
199
265
|
});
|
|
200
266
|
SchemaRenderer.displayName = 'SchemaRenderer';
|
|
@@ -166,7 +166,7 @@ describe('createLazyPlugin', () => {
|
|
|
166
166
|
|
|
167
167
|
await waitFor(() => {
|
|
168
168
|
expect(screen.getByText('Success after retry')).toBeInTheDocument();
|
|
169
|
-
}, { timeout:
|
|
169
|
+
}, { timeout: 2000 });
|
|
170
170
|
|
|
171
171
|
// First call + 2 retries (fails) + 1 success = called 3 times
|
|
172
172
|
expect(importFn).toHaveBeenCalledTimes(3);
|
|
@@ -0,0 +1,69 @@
|
|
|
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
|
+
|
|
9
|
+
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
|
10
|
+
import { render } from '@testing-library/react';
|
|
11
|
+
import React from 'react';
|
|
12
|
+
import { ComponentRegistry } from '@object-ui/core';
|
|
13
|
+
import { SchemaRenderer } from '../SchemaRenderer';
|
|
14
|
+
import { SchemaRendererProvider } from '../context/SchemaRendererContext';
|
|
15
|
+
|
|
16
|
+
// Suppress console.warn from deprecated namespace registration
|
|
17
|
+
const originalWarn = console.warn;
|
|
18
|
+
beforeEach(() => {
|
|
19
|
+
console.warn = vi.fn();
|
|
20
|
+
});
|
|
21
|
+
afterEach(() => {
|
|
22
|
+
console.warn = originalWarn;
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
// A simple test component that passes all props through to a div
|
|
26
|
+
const TestDiv: React.FC<any> = (props) => {
|
|
27
|
+
const { schema, ...rest } = props;
|
|
28
|
+
return <div data-testid="test-div" {...rest} />;
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
describe('SchemaRenderer debug attributes', () => {
|
|
32
|
+
beforeEach(() => {
|
|
33
|
+
ComponentRegistry.register('test-debug-div', TestDiv);
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
it('should NOT inject data-debug-* attributes when debug is off', () => {
|
|
37
|
+
const { getByTestId } = render(
|
|
38
|
+
<SchemaRendererProvider dataSource={{}}>
|
|
39
|
+
<SchemaRenderer schema={{ type: 'test-debug-div', id: 'myBtn' }} />
|
|
40
|
+
</SchemaRendererProvider>,
|
|
41
|
+
);
|
|
42
|
+
const el = getByTestId('test-div');
|
|
43
|
+
expect(el.getAttribute('data-debug-type')).toBeNull();
|
|
44
|
+
expect(el.getAttribute('data-debug-id')).toBeNull();
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
it('should inject data-debug-type when debug is enabled', () => {
|
|
48
|
+
const { getByTestId } = render(
|
|
49
|
+
<SchemaRendererProvider dataSource={{}} debug={true}>
|
|
50
|
+
<SchemaRenderer schema={{ type: 'test-debug-div', id: 'myBtn' }} />
|
|
51
|
+
</SchemaRendererProvider>,
|
|
52
|
+
);
|
|
53
|
+
const el = getByTestId('test-div');
|
|
54
|
+
expect(el.getAttribute('data-debug-type')).toBe('test-debug-div');
|
|
55
|
+
expect(el.getAttribute('data-debug-id')).toBe('myBtn');
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it('should inject data-debug-type when debugFlags.enabled is true', () => {
|
|
59
|
+
const { getByTestId } = render(
|
|
60
|
+
<SchemaRendererProvider dataSource={{}} debugFlags={{ enabled: true }}>
|
|
61
|
+
<SchemaRenderer schema={{ type: 'test-debug-div' }} />
|
|
62
|
+
</SchemaRendererProvider>,
|
|
63
|
+
);
|
|
64
|
+
const el = getByTestId('test-div');
|
|
65
|
+
expect(el.getAttribute('data-debug-type')).toBe('test-debug-div');
|
|
66
|
+
// No id on schema, so data-debug-id should not be present
|
|
67
|
+
expect(el.getAttribute('data-debug-id')).toBeNull();
|
|
68
|
+
});
|
|
69
|
+
});
|
|
@@ -0,0 +1,131 @@
|
|
|
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
|
+
|
|
9
|
+
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
|
10
|
+
import { render, screen } from '@testing-library/react';
|
|
11
|
+
import React from 'react';
|
|
12
|
+
import { ComponentRegistry } from '@object-ui/core';
|
|
13
|
+
import { SchemaRenderer } from '../SchemaRenderer';
|
|
14
|
+
import { SchemaRendererContext } from '../context/SchemaRendererContext';
|
|
15
|
+
|
|
16
|
+
// Simple test component
|
|
17
|
+
const TestComponent = (props: any) => (
|
|
18
|
+
<div data-testid="test-component" data-disabled={props.disabled || undefined}>
|
|
19
|
+
{props.content || props.label || 'Test'}
|
|
20
|
+
</div>
|
|
21
|
+
);
|
|
22
|
+
|
|
23
|
+
describe('SchemaRenderer Expression Integration', () => {
|
|
24
|
+
beforeEach(() => {
|
|
25
|
+
ComponentRegistry.register('test-component', TestComponent);
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
afterEach(() => {
|
|
29
|
+
ComponentRegistry.unregister?.('test-component');
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
describe('visible / hidden expressions', () => {
|
|
33
|
+
it('renders when visible is true', () => {
|
|
34
|
+
render(<SchemaRenderer schema={{ type: 'test-component', visible: true }} />);
|
|
35
|
+
expect(screen.getByTestId('test-component')).toBeInTheDocument();
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
it('does not render when visible is false', () => {
|
|
39
|
+
const { container } = render(<SchemaRenderer schema={{ type: 'test-component', visible: false }} />);
|
|
40
|
+
expect(container.innerHTML).toBe('');
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
it('evaluates visible expression string', () => {
|
|
44
|
+
render(
|
|
45
|
+
<SchemaRendererContext.Provider value={{ dataSource: { role: 'admin' } }}>
|
|
46
|
+
<SchemaRenderer schema={{ type: 'test-component', visible: '${data.role === "admin"}' }} />
|
|
47
|
+
</SchemaRendererContext.Provider>
|
|
48
|
+
);
|
|
49
|
+
expect(screen.getByTestId('test-component')).toBeInTheDocument();
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
it('hides when visible expression evaluates to false', () => {
|
|
53
|
+
const { container } = render(
|
|
54
|
+
<SchemaRendererContext.Provider value={{ dataSource: { role: 'viewer' } }}>
|
|
55
|
+
<SchemaRenderer schema={{ type: 'test-component', visible: '${data.role === "admin"}' }} />
|
|
56
|
+
</SchemaRendererContext.Provider>
|
|
57
|
+
);
|
|
58
|
+
expect(container.innerHTML).toBe('');
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
it('hides when hidden is true', () => {
|
|
62
|
+
const { container } = render(<SchemaRenderer schema={{ type: 'test-component', hidden: true }} />);
|
|
63
|
+
expect(container.innerHTML).toBe('');
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
it('shows when hidden is false', () => {
|
|
67
|
+
render(<SchemaRenderer schema={{ type: 'test-component', hidden: false }} />);
|
|
68
|
+
expect(screen.getByTestId('test-component')).toBeInTheDocument();
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
it('hides with hiddenOn expression', () => {
|
|
72
|
+
const { container } = render(
|
|
73
|
+
<SchemaRendererContext.Provider value={{ dataSource: { status: 'draft' } }}>
|
|
74
|
+
<SchemaRenderer schema={{ type: 'test-component', hiddenOn: '${data.status === "draft"}' }} />
|
|
75
|
+
</SchemaRendererContext.Provider>
|
|
76
|
+
);
|
|
77
|
+
expect(container.innerHTML).toBe('');
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
it('visible takes precedence over hidden', () => {
|
|
81
|
+
render(<SchemaRenderer schema={{ type: 'test-component', visible: true, hidden: true }} />);
|
|
82
|
+
expect(screen.getByTestId('test-component')).toBeInTheDocument();
|
|
83
|
+
});
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
describe('disabled expressions', () => {
|
|
87
|
+
it('passes disabled=true when disabled expression is true', () => {
|
|
88
|
+
render(<SchemaRenderer schema={{ type: 'test-component', disabled: true }} />);
|
|
89
|
+
expect(screen.getByTestId('test-component')).toHaveAttribute('data-disabled', 'true');
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
it('evaluates disabled expression string', () => {
|
|
93
|
+
render(
|
|
94
|
+
<SchemaRendererContext.Provider value={{ dataSource: { status: 'locked' } }}>
|
|
95
|
+
<SchemaRenderer schema={{ type: 'test-component', disabled: '${data.status === "locked"}' }} />
|
|
96
|
+
</SchemaRendererContext.Provider>
|
|
97
|
+
);
|
|
98
|
+
expect(screen.getByTestId('test-component')).toHaveAttribute('data-disabled', 'true');
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
it('does not set disabled when expression is false', () => {
|
|
102
|
+
render(
|
|
103
|
+
<SchemaRendererContext.Provider value={{ dataSource: { status: 'active' } }}>
|
|
104
|
+
<SchemaRenderer schema={{ type: 'test-component', disabled: '${data.status === "locked"}' }} />
|
|
105
|
+
</SchemaRendererContext.Provider>
|
|
106
|
+
);
|
|
107
|
+
expect(screen.getByTestId('test-component')).not.toHaveAttribute('data-disabled');
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
it('evaluates disabledOn expression', () => {
|
|
111
|
+
render(
|
|
112
|
+
<SchemaRendererContext.Provider value={{ dataSource: { readOnly: true } }}>
|
|
113
|
+
<SchemaRenderer schema={{ type: 'test-component', disabledOn: '${data.readOnly}' }} />
|
|
114
|
+
</SchemaRendererContext.Provider>
|
|
115
|
+
);
|
|
116
|
+
expect(screen.getByTestId('test-component')).toHaveAttribute('data-disabled', 'true');
|
|
117
|
+
});
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
describe('defaults', () => {
|
|
121
|
+
it('renders by default when no visibility props are set', () => {
|
|
122
|
+
render(<SchemaRenderer schema={{ type: 'test-component' }} />);
|
|
123
|
+
expect(screen.getByTestId('test-component')).toBeInTheDocument();
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
it('is not disabled by default', () => {
|
|
127
|
+
render(<SchemaRenderer schema={{ type: 'test-component' }} />);
|
|
128
|
+
expect(screen.getByTestId('test-component')).not.toHaveAttribute('data-disabled');
|
|
129
|
+
});
|
|
130
|
+
});
|
|
131
|
+
});
|
|
@@ -198,6 +198,40 @@ describe('useNavigationOverlay', () => {
|
|
|
198
198
|
|
|
199
199
|
expect(mockWindowOpen).toHaveBeenCalledWith('/users/456', '_blank');
|
|
200
200
|
});
|
|
201
|
+
|
|
202
|
+
it('should delegate to onNavigate with new_window action when onNavigate is provided', () => {
|
|
203
|
+
const onNavigate = vi.fn();
|
|
204
|
+
const { result } = renderHook(() =>
|
|
205
|
+
useNavigationOverlay({
|
|
206
|
+
navigation: { mode: 'new_window' },
|
|
207
|
+
objectName: 'contacts',
|
|
208
|
+
onNavigate,
|
|
209
|
+
})
|
|
210
|
+
);
|
|
211
|
+
|
|
212
|
+
act(() => {
|
|
213
|
+
result.current.handleClick({ _id: '789' });
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
expect(onNavigate).toHaveBeenCalledWith('789', 'new_window');
|
|
217
|
+
expect(mockWindowOpen).not.toHaveBeenCalled();
|
|
218
|
+
expect(result.current.isOpen).toBe(false);
|
|
219
|
+
});
|
|
220
|
+
|
|
221
|
+
it('should fallback to window.open when onNavigate is not provided', () => {
|
|
222
|
+
const { result } = renderHook(() =>
|
|
223
|
+
useNavigationOverlay({
|
|
224
|
+
navigation: { mode: 'new_window' },
|
|
225
|
+
objectName: 'accounts',
|
|
226
|
+
})
|
|
227
|
+
);
|
|
228
|
+
|
|
229
|
+
act(() => {
|
|
230
|
+
result.current.handleClick({ _id: '101' });
|
|
231
|
+
});
|
|
232
|
+
|
|
233
|
+
expect(mockWindowOpen).toHaveBeenCalledWith('/accounts/101', '_blank');
|
|
234
|
+
});
|
|
201
235
|
});
|
|
202
236
|
|
|
203
237
|
// ============================================================
|
|
@@ -413,4 +447,132 @@ describe('useNavigationOverlay', () => {
|
|
|
413
447
|
});
|
|
414
448
|
});
|
|
415
449
|
});
|
|
450
|
+
|
|
451
|
+
// ============================================================
|
|
452
|
+
// navigation.view property
|
|
453
|
+
// ============================================================
|
|
454
|
+
|
|
455
|
+
describe('navigation.view property', () => {
|
|
456
|
+
it('should expose the view property from config', () => {
|
|
457
|
+
const { result } = renderHook(() =>
|
|
458
|
+
useNavigationOverlay({
|
|
459
|
+
navigation: { mode: 'drawer', view: 'edit_form' },
|
|
460
|
+
objectName: 'contacts',
|
|
461
|
+
})
|
|
462
|
+
);
|
|
463
|
+
|
|
464
|
+
expect(result.current.view).toBe('edit_form');
|
|
465
|
+
});
|
|
466
|
+
|
|
467
|
+
it('should pass view to onNavigate for page mode', () => {
|
|
468
|
+
const onNavigate = vi.fn();
|
|
469
|
+
const { result } = renderHook(() =>
|
|
470
|
+
useNavigationOverlay({
|
|
471
|
+
navigation: { mode: 'page', view: 'detail_view' },
|
|
472
|
+
objectName: 'contacts',
|
|
473
|
+
onNavigate,
|
|
474
|
+
})
|
|
475
|
+
);
|
|
476
|
+
|
|
477
|
+
act(() => {
|
|
478
|
+
result.current.handleClick({ _id: '123' });
|
|
479
|
+
});
|
|
480
|
+
|
|
481
|
+
expect(onNavigate).toHaveBeenCalledWith('123', 'detail_view');
|
|
482
|
+
});
|
|
483
|
+
|
|
484
|
+
it('should include view in new_window URL', () => {
|
|
485
|
+
const { result } = renderHook(() =>
|
|
486
|
+
useNavigationOverlay({
|
|
487
|
+
navigation: { mode: 'new_window', view: 'edit_form' },
|
|
488
|
+
objectName: 'contacts',
|
|
489
|
+
})
|
|
490
|
+
);
|
|
491
|
+
|
|
492
|
+
act(() => {
|
|
493
|
+
result.current.handleClick({ _id: '123' });
|
|
494
|
+
});
|
|
495
|
+
|
|
496
|
+
expect(mockWindowOpen).toHaveBeenCalledWith('/contacts/123/edit_form', '_blank');
|
|
497
|
+
});
|
|
498
|
+
|
|
499
|
+
it('should return undefined view when not configured', () => {
|
|
500
|
+
const { result } = renderHook(() =>
|
|
501
|
+
useNavigationOverlay({
|
|
502
|
+
navigation: { mode: 'drawer' },
|
|
503
|
+
objectName: 'contacts',
|
|
504
|
+
})
|
|
505
|
+
);
|
|
506
|
+
|
|
507
|
+
expect(result.current.view).toBeUndefined();
|
|
508
|
+
});
|
|
509
|
+
});
|
|
510
|
+
|
|
511
|
+
// ============================================================
|
|
512
|
+
// Stale closure prevention
|
|
513
|
+
// ============================================================
|
|
514
|
+
|
|
515
|
+
describe('stale closure prevention', () => {
|
|
516
|
+
it('should use latest onNavigate after re-render with new callback', () => {
|
|
517
|
+
const onNavigateV1 = vi.fn();
|
|
518
|
+
const onNavigateV2 = vi.fn();
|
|
519
|
+
|
|
520
|
+
const { result, rerender } = renderHook(
|
|
521
|
+
({ onNavigate }) =>
|
|
522
|
+
useNavigationOverlay({
|
|
523
|
+
navigation: { mode: 'page' },
|
|
524
|
+
objectName: 'contacts',
|
|
525
|
+
onNavigate,
|
|
526
|
+
}),
|
|
527
|
+
{ initialProps: { onNavigate: onNavigateV1 } }
|
|
528
|
+
);
|
|
529
|
+
|
|
530
|
+
// First click uses v1
|
|
531
|
+
act(() => {
|
|
532
|
+
result.current.handleClick({ _id: '1' });
|
|
533
|
+
});
|
|
534
|
+
expect(onNavigateV1).toHaveBeenCalledWith('1', 'view');
|
|
535
|
+
expect(onNavigateV2).not.toHaveBeenCalled();
|
|
536
|
+
|
|
537
|
+
// Re-render with new onNavigate
|
|
538
|
+
rerender({ onNavigate: onNavigateV2 });
|
|
539
|
+
|
|
540
|
+
// Second click must use v2 (not stale v1)
|
|
541
|
+
act(() => {
|
|
542
|
+
result.current.handleClick({ _id: '2' });
|
|
543
|
+
});
|
|
544
|
+
expect(onNavigateV2).toHaveBeenCalledWith('2', 'view');
|
|
545
|
+
expect(onNavigateV1).toHaveBeenCalledTimes(1); // v1 was not called again
|
|
546
|
+
});
|
|
547
|
+
|
|
548
|
+
it('should use latest onNavigate after navigation config changes from undefined to page', () => {
|
|
549
|
+
const onNavigate = vi.fn();
|
|
550
|
+
|
|
551
|
+
const { result, rerender } = renderHook(
|
|
552
|
+
({ navigation }) =>
|
|
553
|
+
useNavigationOverlay({
|
|
554
|
+
navigation,
|
|
555
|
+
objectName: 'contacts',
|
|
556
|
+
onNavigate,
|
|
557
|
+
}),
|
|
558
|
+
{ initialProps: { navigation: undefined as NavigationConfig | undefined } }
|
|
559
|
+
);
|
|
560
|
+
|
|
561
|
+
// Click with no config — should still call onNavigate (default page behavior)
|
|
562
|
+
act(() => {
|
|
563
|
+
result.current.handleClick({ _id: '1' });
|
|
564
|
+
});
|
|
565
|
+
expect(onNavigate).toHaveBeenCalledWith('1', 'view');
|
|
566
|
+
|
|
567
|
+
// Re-render with explicit page config
|
|
568
|
+
rerender({ navigation: { mode: 'page' } });
|
|
569
|
+
|
|
570
|
+
// Click should still work (not stale)
|
|
571
|
+
act(() => {
|
|
572
|
+
result.current.handleClick({ _id: '2' });
|
|
573
|
+
});
|
|
574
|
+
expect(onNavigate).toHaveBeenCalledWith('2', 'view');
|
|
575
|
+
expect(onNavigate).toHaveBeenCalledTimes(2);
|
|
576
|
+
});
|
|
577
|
+
});
|
|
416
578
|
});
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import React, { createContext, useContext, useMemo } from 'react';
|
|
2
|
+
import type { DebugFlags } from '@object-ui/core';
|
|
2
3
|
|
|
3
4
|
interface SchemaRendererContextType {
|
|
4
5
|
dataSource: any;
|
|
5
6
|
debug?: boolean;
|
|
7
|
+
debugFlags?: DebugFlags;
|
|
6
8
|
}
|
|
7
9
|
|
|
8
10
|
const SchemaRendererContext = createContext<SchemaRendererContextType | null>(null);
|
|
@@ -12,13 +14,15 @@ export { SchemaRendererContext };
|
|
|
12
14
|
export const SchemaRendererProvider = ({
|
|
13
15
|
children,
|
|
14
16
|
dataSource,
|
|
15
|
-
debug
|
|
17
|
+
debug,
|
|
18
|
+
debugFlags,
|
|
16
19
|
}: {
|
|
17
20
|
children: React.ReactNode;
|
|
18
21
|
dataSource: any;
|
|
19
|
-
debug?: boolean
|
|
22
|
+
debug?: boolean;
|
|
23
|
+
debugFlags?: DebugFlags;
|
|
20
24
|
}) => {
|
|
21
|
-
const value = useMemo(() => ({ dataSource, debug }), [dataSource, debug]);
|
|
25
|
+
const value = useMemo(() => ({ dataSource, debug, debugFlags }), [dataSource, debug, debugFlags]);
|
|
22
26
|
return (
|
|
23
27
|
<SchemaRendererContext.Provider value={value}>
|
|
24
28
|
{children}
|
|
@@ -37,7 +41,8 @@ export const useSchemaContext = () => {
|
|
|
37
41
|
export const useDataScope = (path?: string) => {
|
|
38
42
|
const context = useContext(SchemaRendererContext);
|
|
39
43
|
const dataSource = context?.dataSource;
|
|
40
|
-
if (!
|
|
44
|
+
if (!path) return undefined;
|
|
45
|
+
if (!dataSource) return undefined;
|
|
41
46
|
// Simple path resolution for now. In real app might be more complex
|
|
42
47
|
return path.split('.').reduce((acc, part) => acc && acc[part], dataSource);
|
|
43
48
|
}
|