@judo/core 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/LICENSE +277 -0
  2. package/README.md +213 -0
  3. package/dist/contexts/application-context.d.ts +46 -0
  4. package/dist/contexts/application-context.d.ts.map +1 -0
  5. package/dist/contexts/customizations-context.d.ts +227 -0
  6. package/dist/contexts/customizations-context.d.ts.map +1 -0
  7. package/dist/contexts/data-context.d.ts +30 -0
  8. package/dist/contexts/data-context.d.ts.map +1 -0
  9. package/dist/contexts/dispatch-context.d.ts +39 -0
  10. package/dist/contexts/dispatch-context.d.ts.map +1 -0
  11. package/dist/contexts/index.d.ts +12 -0
  12. package/dist/contexts/index.d.ts.map +1 -0
  13. package/dist/contexts/mui-pro-context.d.ts +52 -0
  14. package/dist/contexts/mui-pro-context.d.ts.map +1 -0
  15. package/dist/contexts/navigation-context.d.ts +113 -0
  16. package/dist/contexts/navigation-context.d.ts.map +1 -0
  17. package/dist/contexts/page-context.d.ts +43 -0
  18. package/dist/contexts/page-context.d.ts.map +1 -0
  19. package/dist/contexts/refresh-signal-context.d.ts +18 -0
  20. package/dist/contexts/refresh-signal-context.d.ts.map +1 -0
  21. package/dist/contexts/runtime-config-context.d.ts +70 -0
  22. package/dist/contexts/runtime-config-context.d.ts.map +1 -0
  23. package/dist/contexts/selector-selection-context.d.ts +44 -0
  24. package/dist/contexts/selector-selection-context.d.ts.map +1 -0
  25. package/dist/contexts/validation-context.d.ts +57 -0
  26. package/dist/contexts/validation-context.d.ts.map +1 -0
  27. package/dist/hooks/index.d.ts +9 -0
  28. package/dist/hooks/index.d.ts.map +1 -0
  29. package/dist/hooks/use-data-selector.d.ts +51 -0
  30. package/dist/hooks/use-data-selector.d.ts.map +1 -0
  31. package/dist/hooks/use-debounced-callback.d.ts +36 -0
  32. package/dist/hooks/use-debounced-callback.d.ts.map +1 -0
  33. package/dist/hooks/use-edit-mode.d.ts +23 -0
  34. package/dist/hooks/use-edit-mode.d.ts.map +1 -0
  35. package/dist/hooks/use-element-disabled.d.ts +16 -0
  36. package/dist/hooks/use-element-disabled.d.ts.map +1 -0
  37. package/dist/hooks/use-element-visibility.d.ts +16 -0
  38. package/dist/hooks/use-element-visibility.d.ts.map +1 -0
  39. package/dist/hooks/use-validation.d.ts +32 -0
  40. package/dist/hooks/use-validation.d.ts.map +1 -0
  41. package/dist/hooks/use-visual-binding.d.ts +38 -0
  42. package/dist/hooks/use-visual-binding.d.ts.map +1 -0
  43. package/dist/hooks/use-visual-element.d.ts +13 -0
  44. package/dist/hooks/use-visual-element.d.ts.map +1 -0
  45. package/dist/index.d.ts +11 -0
  46. package/dist/index.d.ts.map +1 -0
  47. package/dist/index.js +764 -0
  48. package/dist/index.js.map +1 -0
  49. package/dist/store/data-store.d.ts +168 -0
  50. package/dist/store/data-store.d.ts.map +1 -0
  51. package/dist/store/index.d.ts +3 -0
  52. package/dist/store/index.d.ts.map +1 -0
  53. package/dist/store/selectors.d.ts +58 -0
  54. package/dist/store/selectors.d.ts.map +1 -0
  55. package/dist/utils/deep-equal.d.ts +10 -0
  56. package/dist/utils/deep-equal.d.ts.map +1 -0
  57. package/dist/utils/index.d.ts +2 -0
  58. package/dist/utils/index.d.ts.map +1 -0
  59. package/package.json +58 -0
package/LICENSE ADDED
@@ -0,0 +1,277 @@
1
+ Eclipse Public License - v 2.0
2
+
3
+ THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
4
+ PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
5
+ OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
6
+
7
+ 1. DEFINITIONS
8
+
9
+ "Contribution" means:
10
+
11
+ a) in the case of the initial Contributor, the initial content
12
+ Distributed under this Agreement, and
13
+
14
+ b) in the case of each subsequent Contributor:
15
+ i) changes to the Program, and
16
+ ii) additions to the Program;
17
+ where such changes and/or additions to the Program originate from
18
+ and are Distributed by that particular Contributor. A Contribution
19
+ "originates" from a Contributor if it was added to the Program by
20
+ such Contributor itself or anyone acting on such Contributor's behalf.
21
+ Contributions do not include changes or additions to the Program that
22
+ are not Modified Works.
23
+
24
+ "Contributor" means any person or entity that Distributes the Program.
25
+
26
+ "Licensed Patents" mean patent claims licensable by a Contributor which
27
+ are necessarily infringed by the use or sale of its Contribution alone
28
+ or when combined with the Program.
29
+
30
+ "Program" means the Contributions Distributed in accordance with this
31
+ Agreement.
32
+
33
+ "Recipient" means anyone who receives the Program under this Agreement
34
+ or any Secondary License (as applicable), including Contributors.
35
+
36
+ "Derivative Works" shall mean any work, whether in Source Code or other
37
+ form, that is based on (or derived from) the Program and for which the
38
+ editorial revisions, annotations, elaborations, or other modifications
39
+ represent, as a whole, an original work of authorship.
40
+
41
+ "Modified Works" shall mean any work in Source Code or other form that
42
+ results from an addition to, deletion from, or modification of the
43
+ contents of the Program, including, for purposes of clarity any new file
44
+ in Source Code form that contains any contents of the Program. Modified
45
+ Works shall not include works that contain only declarations,
46
+ interfaces, types, classes, structures, or files of the Program solely
47
+ in each case in order to link to, bind by name, or subclass the Program
48
+ or Modified Works thereof.
49
+
50
+ "Distribute" means the acts of a) distributing or b) making available
51
+ in any manner that enables the transfer of a copy.
52
+
53
+ "Source Code" means the form of a Program preferred for making
54
+ modifications, including but not limited to software source code,
55
+ documentation source, and configuration files.
56
+
57
+ "Secondary License" means either the GNU General Public License,
58
+ Version 2.0, or any later versions of that license, including any
59
+ exceptions or additional permissions as identified by the initial
60
+ Contributor.
61
+
62
+ 2. GRANT OF RIGHTS
63
+
64
+ a) Subject to the terms of this Agreement, each Contributor hereby
65
+ grants Recipient a non-exclusive, worldwide, royalty-free copyright
66
+ license to reproduce, prepare Derivative Works of, publicly display,
67
+ publicly perform, Distribute and sublicense the Contribution of such
68
+ Contributor, if any, and such Derivative Works.
69
+
70
+ b) Subject to the terms of this Agreement, each Contributor hereby
71
+ grants Recipient a non-exclusive, worldwide, royalty-free patent
72
+ license under Licensed Patents to make, use, sell, offer to sell,
73
+ import and otherwise transfer the Contribution of such Contributor,
74
+ if any, in Source Code or other form. This patent license shall
75
+ apply to the combination of the Contribution and the Program if, at
76
+ the time the Contribution is added by the Contributor, such addition
77
+ of the Contribution causes such combination to be covered by the
78
+ Licensed Patents. The patent license shall not apply to any other
79
+ combinations which include the Contribution. No hardware per se is
80
+ licensed hereunder.
81
+
82
+ c) Recipient understands that although each Contributor grants the
83
+ licenses to its Contributions set forth herein, no assurances are
84
+ provided by any Contributor that the Program does not infringe the
85
+ patent or other intellectual property rights of any other entity.
86
+ Each Contributor disclaims any liability to Recipient for claims
87
+ brought by any other entity based on infringement of intellectual
88
+ property rights or otherwise. As a condition to exercising the
89
+ rights and licenses granted hereunder, each Recipient hereby
90
+ assumes sole responsibility to secure any other intellectual
91
+ property rights needed, if any. For example, if a third party
92
+ patent license is required to allow Recipient to Distribute the
93
+ Program, it is Recipient's responsibility to acquire that license
94
+ before distributing the Program.
95
+
96
+ d) Each Contributor represents that to its knowledge it has
97
+ sufficient copyright rights in its Contribution, if any, to grant
98
+ the copyright license set forth in this Agreement.
99
+
100
+ e) Notwithstanding the terms of any Secondary License, no
101
+ Contributor makes additional grants to any Recipient (other than
102
+ those set forth in this Agreement) as a result of such Recipient's
103
+ receipt of the Program under the terms of a Secondary License
104
+ (if permitted under the terms of Section 3).
105
+
106
+ 3. REQUIREMENTS
107
+
108
+ 3.1 If a Contributor Distributes the Program in any form, then:
109
+
110
+ a) the Program must also be made available as Source Code, in
111
+ accordance with section 3.2, and the Contributor must accompany
112
+ the Program with a statement that the Source Code for the Program
113
+ is available under this Agreement, and informs Recipients how to
114
+ obtain it in a reasonable manner on or through a medium customarily
115
+ used for software exchange; and
116
+
117
+ b) the Contributor may Distribute the Program under a license
118
+ different than this Agreement, provided that such license:
119
+ i) effectively disclaims on behalf of all other Contributors all
120
+ warranties and conditions, express and implied, including
121
+ warranties or conditions of title and non-infringement, and
122
+ implied warranties or conditions of merchantability and fitness
123
+ for a particular purpose;
124
+
125
+ ii) effectively excludes on behalf of all other Contributors all
126
+ liability for damages, including direct, indirect, special,
127
+ incidental and consequential damages, such as lost profits;
128
+
129
+ iii) does not attempt to limit or alter the recipients' rights
130
+ in the Source Code under section 3.2; and
131
+
132
+ iv) requires any subsequent distribution of the Program by any
133
+ party to be under a license that satisfies the requirements
134
+ of this section 3.
135
+
136
+ 3.2 When the Program is Distributed as Source Code:
137
+
138
+ a) it must be made available under this Agreement, or if the
139
+ Program (i) is combined with other material in a separate file or
140
+ files made available under a Secondary License, and (ii) the initial
141
+ Contributor attached to the Source Code the notice described in
142
+ Exhibit A of this Agreement, then the Program may be made available
143
+ under the terms of such Secondary Licenses, and
144
+
145
+ b) a copy of this Agreement must be included with each copy of
146
+ the Program.
147
+
148
+ 3.3 Contributors may not remove or alter any copyright, patent,
149
+ trademark, attribution notices, disclaimers of warranty, or limitations
150
+ of liability ("notices") contained within the Program from any copy of
151
+ the Program which they Distribute, provided that Contributors may add
152
+ their own appropriate notices.
153
+
154
+ 4. COMMERCIAL DISTRIBUTION
155
+
156
+ Commercial distributors of software may accept certain responsibilities
157
+ with respect to end users, business partners and the like. While this
158
+ license is intended to facilitate the commercial use of the Program,
159
+ the Contributor who includes the Program in a commercial product
160
+ offering should do so in a manner which does not create potential
161
+ liability for other Contributors. Therefore, if a Contributor includes
162
+ the Program in a commercial product offering, such Contributor
163
+ ("Commercial Contributor") hereby agrees to defend and indemnify every
164
+ other Contributor ("Indemnified Contributor") against any losses,
165
+ damages and costs (collectively "Losses") arising from claims, lawsuits
166
+ and other legal actions brought by a third party against the Indemnified
167
+ Contributor to the extent caused by the acts or omissions of such
168
+ Commercial Contributor in connection with its distribution of the Program
169
+ in a commercial product offering. The obligations in this section do not
170
+ apply to any claims or Losses relating to any actual or alleged
171
+ intellectual property infringement. In order to qualify, an Indemnified
172
+ Contributor must: a) promptly notify the Commercial Contributor in
173
+ writing of such claim, and b) allow the Commercial Contributor to control,
174
+ and cooperate with the Commercial Contributor in, the defense and any
175
+ related settlement negotiations. The Indemnified Contributor may
176
+ participate in any such claim at its own expense.
177
+
178
+ For example, a Contributor might include the Program in a commercial
179
+ product offering, Product X. That Contributor is then a Commercial
180
+ Contributor. If that Commercial Contributor then makes performance
181
+ claims, or offers warranties related to Product X, those performance
182
+ claims and warranties are such Commercial Contributor's responsibility
183
+ alone. Under this section, the Commercial Contributor would have to
184
+ defend claims against the other Contributors related to those performance
185
+ claims and warranties, and if a court requires any other Contributor to
186
+ pay any damages as a result, the Commercial Contributor must pay
187
+ those damages.
188
+
189
+ 5. NO WARRANTY
190
+
191
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
192
+ PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
193
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
194
+ IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
195
+ TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
196
+ PURPOSE. Each Recipient is solely responsible for determining the
197
+ appropriateness of using and distributing the Program and assumes all
198
+ risks associated with its exercise of rights under this Agreement,
199
+ including but not limited to the risks and costs of program errors,
200
+ compliance with applicable laws, damage to or loss of data, programs
201
+ or equipment, and unavailability or interruption of operations.
202
+
203
+ 6. DISCLAIMER OF LIABILITY
204
+
205
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
206
+ PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
207
+ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
208
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
209
+ PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
210
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
211
+ ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
212
+ EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
213
+ POSSIBILITY OF SUCH DAMAGES.
214
+
215
+ 7. GENERAL
216
+
217
+ If any provision of this Agreement is invalid or unenforceable under
218
+ applicable law, it shall not affect the validity or enforceability of
219
+ the remainder of the terms of this Agreement, and without further
220
+ action by the parties hereto, such provision shall be reformed to the
221
+ minimum extent necessary to make such provision valid and enforceable.
222
+
223
+ If Recipient institutes patent litigation against any entity
224
+ (including a cross-claim or counterclaim in a lawsuit) alleging that the
225
+ Program itself (excluding combinations of the Program with other software
226
+ or hardware) infringes such Recipient's patent(s), then such Recipient's
227
+ rights granted under Section 2(b) shall terminate as of the date such
228
+ litigation is filed.
229
+
230
+ All Recipient's rights under this Agreement shall terminate if it
231
+ fails to comply with any of the material terms or conditions of this
232
+ Agreement and does not cure such failure in a reasonable period of
233
+ time after becoming aware of such noncompliance. If all Recipient's
234
+ rights under this Agreement terminate, Recipient agrees to cease use
235
+ and distribution of the Program as soon as reasonably practicable.
236
+ However, Recipient's obligations under this Agreement and any licenses
237
+ granted by Recipient relating to the Program shall continue and survive.
238
+
239
+ Everyone is permitted to copy and distribute copies of this Agreement,
240
+ but in order to avoid inconsistency the Agreement is copyrighted and
241
+ may only be modified in the following manner. The Agreement Steward
242
+ reserves the right to publish new versions (including revisions) of
243
+ this Agreement from time to time. No one other than the Agreement
244
+ Steward has the right to modify this Agreement. The Eclipse Foundation
245
+ is the initial Agreement Steward. The Eclipse Foundation may assign the
246
+ responsibility to serve as the Agreement Steward to a suitable separate
247
+ entity. Each new version of the Agreement will be given a distinguishing
248
+ version number. The Program (including Contributions) may always be
249
+ Distributed subject to the version of the Agreement under which it was
250
+ received. In addition, after a new version of the Agreement is published,
251
+ Contributor may elect to Distribute the Program (including its
252
+ Contributions) under the new version.
253
+
254
+ Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
255
+ receives no rights or licenses to the intellectual property of any
256
+ Contributor under this Agreement, whether expressly, by implication,
257
+ estoppel or otherwise. All rights in the Program not expressly granted
258
+ under this Agreement are reserved. Nothing in this Agreement is intended
259
+ to be enforceable by any entity that is not a Contributor or Recipient.
260
+ No third-party beneficiary rights are created under this Agreement.
261
+
262
+ Exhibit A - Form of Secondary Licenses Notice
263
+
264
+ "This Source Code may also be made available under the following
265
+ Secondary Licenses when the conditions for such availability set forth
266
+ in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
267
+ version(s), and exceptions or additional permissions here}."
268
+
269
+ Simply including a copy of this Agreement, including this Exhibit A
270
+ is not sufficient to license the Source Code under Secondary Licenses.
271
+
272
+ If it is not possible or desirable to put the notice in a particular
273
+ file, then You may include the notice in a location (such as a LICENSE
274
+ file in a relevant directory) where a recipient would be likely to
275
+ look for such a notice.
276
+
277
+ You may add additional accurate notices of copyright ownership.
package/README.md ADDED
@@ -0,0 +1,213 @@
1
+ # @judo/core
2
+
3
+ > Core React contexts and hooks for JUDO UI Runtime
4
+
5
+ ## Purpose
6
+
7
+ Central state management layer providing application context, navigation, data binding, validation, dispatch, runtime configuration, customizations, and refresh signaling. This is the **heart of the React runtime** — it bridges model definitions to live React component trees.
8
+
9
+ ## Architecture Layer
10
+
11
+ **Layer 3 (Infrastructure)** — consumed by components, app-shell, and actions packages.
12
+
13
+ ## Dependencies
14
+
15
+ - `@judo/model-api` — model type definitions
16
+ - `@judo/model-loader` — model registry
17
+ - `@judo/actions` — action types (used by `DispatchContext`)
18
+ - `react ^19` — React (peer)
19
+
20
+ ## File Structure
21
+
22
+ ```
23
+ src/
24
+ ├── index.ts # Barrel re-export
25
+ ├── contexts/
26
+ │ ├── application-context.tsx # Application/actor context
27
+ │ ├── navigation-context.tsx # Page stack + dialog navigation
28
+ │ ├── data-context.tsx # DataStore provider
29
+ │ ├── dispatch-context.tsx # Action dispatch provider
30
+ │ ├── page-context.tsx # Current page metadata
31
+ │ ├── refresh-signal-context.tsx # Post-operation refresh signal
32
+ │ ├── runtime-config-context.tsx # Feature flags / runtime config
33
+ │ ├── validation-context.tsx # Form-level validation state
34
+ │ ├── customizations-context.tsx # Component overrides, interceptors, page customizations
35
+ │ ├── mui-pro-context.tsx # MUI X Pro component access
36
+ │ ├── selector-selection-context.tsx # Selector dialog selection sharing
37
+ │ └── index.ts # Barrel re-export for contexts
38
+ ├── hooks/
39
+ │ ├── use-visual-binding.ts # Visual element ↔ data store binding (incl. hiddenBy/enabledBy/requiredBy)
40
+ │ ├── use-element-visibility.ts # hiddenBy runtime evaluation for any VisualElement
41
+ │ ├── use-element-disabled.ts # enabledBy runtime evaluation for any VisualElement
42
+ │ ├── use-validation.ts # Per-element validation + useFormValidation
43
+ │ ├── use-data-selector.ts # Selector-based data subscriptions
44
+ │ ├── use-edit-mode.ts # Edit/dirty mode detection
45
+ │ ├── use-visual-element.ts # Visual element lookup utility
46
+ │ ├── use-debounced-callback.ts # Debounced callback for typeahead/autocomplete
47
+ │ └── index.ts # Barrel re-export for hooks
48
+ ├── store/
49
+ │ ├── data-store.ts # DataStore class (external store)
50
+ │ ├── selectors.ts # Selector factory functions
51
+ │ └── index.ts # Barrel re-export for store
52
+ └── utils/
53
+ ├── deep-equal.ts # Deep equality comparison
54
+ └── index.ts # Barrel re-export for utils
55
+ ```
56
+
57
+ ## Exports Summary
58
+
59
+ ### Context Providers (11)
60
+
61
+ | Provider | Key Props | Purpose |
62
+ | --------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
63
+ | `ApplicationProvider` | `registry` | Subscribes to `ModelRegistry` via `useSyncExternalStore`. Exposes active application + actor switching. |
64
+ | `NavigationProvider` | `initialPage?`, `navigate?`, `getRouteForPage?` | Page stack navigation, dialog open/close with callbacks, React Router integration. |
65
+ | `DataProvider` | `store?` | Creates/wraps a `DataStore` instance in React context. |
66
+ | `ValidationProvider` | — | Manages field errors (`Map`) and touched state (`Set`). |
67
+ | `PageProvider` | `pageDefinition`, `transferId?`, `params?`, `isDialog?` | Current page metadata. |
68
+ | `RuntimeConfigProvider` | `config?` | Feature flags (guards, forceShowTotalCount, headerFilters) and MUI Pro license key. |
69
+ | `DispatchProvider` | `dispatch` | Action dispatch function for the component tree. |
70
+ | `RefreshSignalProvider` | `signal` | Page-level refresh signal. ViewContainerRenderer increments after successful operations; embedded components watch and re-dispatch refresh logic. |
71
+ | `CustomizationsProvider` | `customizations?` | Component overrides, interceptors, page-scoped customization bundles. HMR support via ref + version counter. |
72
+ | `MuiProProvider` | `isProEnabled`, `components?` | Provides Pro variants of MUI X components (e.g., `DataGridPro`). Activated when MUI Pro license is set. |
73
+ | `SelectorSelectionProvider` | `ownerTransfer?` | Shares selection state (via mutable ref) between table and dialog footer in selector dialogs. |
74
+
75
+ Each provider exports a **mandatory hook** (`useX()` — throws if outside provider) and an **optional hook** (`useXOptional()` — returns null), except `RefreshSignalProvider` which provides only `useRefreshSignal()` (returns 0 when outside provider).
76
+
77
+ ### DataStore
78
+
79
+ | Export | Kind | Description |
80
+ | ---------------------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
81
+ | `TransferData` | interface | Shape of transfer data objects with JUDO internal properties (`__signedIdentifier`, `__identifier`, etc.). |
82
+ | `TransferState` | interface | Per-transfer tracked state: `data`, `originalData`, `isDirty`, `isLoading`, `error`. |
83
+ | `DataStoreState` | interface | Full store state: `transfers` map + `version` counter. |
84
+ | `DataSelector<T>` | type | Selector function: `(state: DataStoreState) => T`. |
85
+ | `createEmptyTransferState()` | function | Factory returning a new empty `TransferState`. |
86
+ | `DataStore` (class) | class | External store (not React state) with selector-based subscriptions. |
87
+
88
+ **DataStore methods:**
89
+
90
+ | Method | Description |
91
+ | ----------------------------------------------- | --------------------------------------------------------------------------------------- |
92
+ | `subscribe(selector, callback)` | Subscribe to a data slice. Only fires when selected value changes. Returns unsubscribe. |
93
+ | `getSnapshot(selector)` | Returns current value for a selector. |
94
+ | `getState()` | Returns full state (debug/test). |
95
+ | `getTransfer(transferId)` | Get transfer state by ID. |
96
+ | `setTransferData(transferId, data)` | Sets transfer data & originalData, resets dirty/loading/error. |
97
+ | `updateTransferField(transferId, field, value)` | Updates one field, recalculates `isDirty`. Creates transfer if absent. |
98
+ | `updateTransferFields(transferId, updates)` | Batch field updates, recalculates `isDirty`. |
99
+ | `setTransferLoading(transferId, loading)` | Toggle loading state. |
100
+ | `setTransferError(transferId, error)` | Set error, clears loading. |
101
+ | `resetTransfer(transferId)` | Reverts data to originalData, clears dirty. |
102
+ | `clearTransfer(transferId)` | Removes transfer from store. |
103
+ | `clearAll()` | Clears all transfers. |
104
+
105
+ ### Selector Factories
106
+
107
+ | Function | Description |
108
+ | ---------------------------------------- | ----------------------------------------------- |
109
+ | `selectTransfer(transferId)` | Selector for entire transfer state. |
110
+ | `selectTransferField(transferId, field)` | Selector for a single field value. |
111
+ | `selectTransferLoading(transferId)` | Selector for loading state. |
112
+ | `selectTransferError(transferId)` | Selector for error state. |
113
+ | `selectTransferDirty(transferId)` | Selector for dirty state. |
114
+ | `selectTransferIds` | Direct selector returning all transfer IDs. |
115
+ | `selectVersion` | Direct selector returning store version number. |
116
+
117
+ ### React Hooks
118
+
119
+ | Hook | Description |
120
+ | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
121
+ | `useApplication()` / `useApplicationOptional()` | Access application context (`ApplicationContextType`). |
122
+ | `useNavigation()` / `useNavigationOptional()` | Access navigation context (page stack, dialogs). |
123
+ | `useDataStore()` / `useDataStoreOptional()` | Access `DataStore` instance. |
124
+ | `useValidationContext()` / `useValidationContextOptional()` | Access validation context (field errors, touched state). |
125
+ | `usePageContext()` / `usePageContextOptional()` | Access current page metadata. |
126
+ | `useRuntimeConfig()` / `useRuntimeConfigOptional()` | Access runtime configuration (returns `RuntimeConfigContextType`). |
127
+ | `useDispatch()` / `useDispatchOptional()` | Access action dispatch function. |
128
+ | `useCustomizations()` / `useCustomizationsOptional()` | Access customizations context (component overrides, interceptors, page customizations). |
129
+ | `useMuiPro()` / `useMuiProOptional()` | Access MUI Pro component context. |
130
+ | `useSelectorSelection()` / `useSelectorSelectionOptional()` | Access selector dialog selection state. |
131
+ | `useVisualBinding(element, attributeType?)` | **Core binding hook.** Subscribes to `DataStore` for attribute data. Resolves label, hidden, disabled, required, readOnly. Integrates `hiddenBy`, `enabledBy`, `requiredBy` dynamic behavior and validation for errors. |
132
+ | `useElementVisibility(element)` | Evaluates runtime hidden state of any `VisualElement` via `hiddenBy` dynamic data, static `hidden`, and customization overrides. Safe outside `DataProvider`. |
133
+ | `useElementDisabled(element)` | Evaluates runtime disabled state of any `VisualElement` via `enabledBy` dynamic data, static `disabled`, and customization overrides. `enabledBy` fully controls disabled when present. Safe outside `DataProvider`. |
134
+ | `useValidation(element)` | Per-element validation. Returns `ValidationResult` with error (only for touched fields), touch/setError/clearError methods. |
135
+ | `useFormValidation()` | Alias for `useValidationContext()` — throws if outside `ValidationProvider`. |
136
+ | `useDataSelector(selector)` | Generic selector subscription via `useSyncExternalStore`. |
137
+ | `useTransferState(transferId)` | Convenience hook for full transfer state. |
138
+ | `useTransferField(transferId, field)` | Convenience hook for single field value. |
139
+ | `useTransferLoading(transferId)` | Convenience hook for transfer loading state. |
140
+ | `useTransferDirty(transferId)` | Convenience hook for transfer dirty state. |
141
+ | `useEditMode()` | Derives edit mode from `PageContext` transfer ID + `DataStore` dirty state. No parameters — reads context directly. |
142
+ | `useRefreshSignal()` | Returns current page-level refresh signal (0 when outside provider). |
143
+ | `useComponentOverride(element)` | Returns custom component for element by sourceId, or null. |
144
+ | `useComponentInterceptor(element)` | Returns intercepted component for element by `@type`, or null. |
145
+ | `useSubThemeProvider(element)` | Returns the `SubThemeHook` for an element's `subTheme` property, or null. |
146
+ | `usePageActionOverrides(page, action)` | Returns action lifecycle overrides for an action on a page. |
147
+ | `useVisualPropertyOverrides(element)` | Returns visual property overrides for an element. |
148
+ | `useResolvedPageActionOverrides()` | Returns all resolved action overrides for current page. |
149
+ | `useActionLifecycleOverrides(actionSourceId)` | Returns lifecycle overrides for a specific action by sourceId. |
150
+ | `useTypeaheadProvider(elementSourceId)` | Returns the typeahead provider for a text input, resolved from page-scoped `PageCustomization`. |
151
+ | `useTableRowHighlighting(elementSourceId)` | Returns the `TableRowHighlightConfig[]` for a table element, resolved from page-scoped `PageCustomization`. |
152
+ | `useEnumOptionFilter(elementSourceId)` | Returns a wrapped filter function for enum input options. Subscribes to transfer data changes for reactive re-evaluation. |
153
+ | `useDateValidationProps(elementSourceId)` | Returns `DateValidationProps` for a date/datetime input. Subscribes to transfer data changes for reactive re-evaluation. |
154
+ | `useColumnCustomizers()` | Returns all column customizer functions for the current page from `PageCustomization.columnCustomizers`. |
155
+ | `useItemContainerConfig(elementSourceId)` | Returns `ItemContainerConfig` for a table element from `PageCustomization.itemContainerConfigs`. |
156
+ | `useDebouncedCallback(callback, delay?)` | Returns a debounced version of the callback (default 300ms). Used by autocomplete/typeahead. |
157
+ | `getVisualElement(registry, sourceId)` | Utility function (not a hook) — looks up a `VisualElement` by sourceId from model registry. |
158
+
159
+ ### Additional Exported Components
160
+
161
+ | Export | Kind | Description |
162
+ | ----------------------------- | --------- | -------------------------------------------------------------------------------------------------------- |
163
+ | `PageActionOverridesProvider` | component | Calls registered page action hook and provides resolved overrides to descendants. Inside `PageProvider`. |
164
+ | `VisualPropertiesProvider` | component | Calls registered visual properties hook and provides overrides to descendants. Inside `PageProvider`. |
165
+
166
+ ### Context Types
167
+
168
+ | Type | Description |
169
+ | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
170
+ | `ApplicationContextType` | `application`, `applications`, `actorName`, `switchActor`, `switchActorWithNavigation` |
171
+ | `NavigationContextType` | Extends `NavigationState`. Methods: `navigateTo`, `goBack`, `openDialog`, `closeDialog`, `replacePage`, `clearStack`, `dialog`, `canGoBack` |
172
+ | `PageStackEntry` | `pageDefinition`, `params?`, `scrollPosition?` |
173
+ | `NavigationState` | `pageStack`, `currentPage`, `dialogStack` |
174
+ | `DialogState` | `pageDefinition`, `size`, `params?` |
175
+ | `DialogCloseResultType` | `"cancelled" \| "created" \| "updated" \| "deleted" \| "selected" \| "submitted"` |
176
+ | `DialogCloseResult` | Discriminated union for each result type (e.g., `{ type: "created"; isEager: boolean; data?: unknown }`) |
177
+ | `DialogCloseCallback` | `(result?: DialogCloseResult) => void` |
178
+ | `PageContextType` | `pageDefinition`, `transferId`, `params`, `isDialog` |
179
+ | `ValidationContextType` | Methods: `getError`, `setError`, `setErrors`, `touch`, `isTouched`, `clearErrors`, `clearError`, `validateAll`, `getAllErrors`, `isValid` |
180
+ | `ValidationState` | `errors: Map<string, string>`, `touched: Set<string>` |
181
+ | `RuntimeConfig` | `features?: FeaturesConfig`, `muiProLicenseKey?` |
182
+ | `FeaturesConfig` | `guards?`, `forceShowTotalCountForLazyTables?`, `headerFilters?` |
183
+ | `RuntimeConfigContextType` | `{ config: RuntimeConfig }` |
184
+ | `DispatchFn` | `(action: Action) => Promise<unknown>` (uses `Action` from `@judo/actions`) |
185
+ | `DispatchContextType` | `{ dispatch: DispatchFn }` |
186
+ | `CustomizationsContextType` | `version`, `getPageCustomization`, `getComponent`, `getComponentInterceptor`, `getSubThemeProvider`, `getRedirectHandler`, `getCustomRoutes`, `getMenuCustomizer`, `getFooterText`, `getHeroComponent`, `getSettingsPage`, `getGuestComponent` |
187
+ | `MuiProContextType` | `isProEnabled`, `getComponent(name)` |
188
+ | `SelectorSelectionContextType` | `selectedTransfersRef` (mutable ref), `ownerTransfer?` |
189
+ | `VisualBindingResult` | `value`, `onChange`, `error`, `hidden`, `disabled`, `required`, `label`, `readOnly`, `isLoading`, `isDirty` |
190
+ | `ValidationResult` | `error`, `isTouched`, `touch()`, `setError()`, `clearError()` |
191
+ | `EditModeResult` | `isEditMode`, `transferId` |
192
+
193
+ ### Utilities
194
+
195
+ | Export | Kind | Description |
196
+ | --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
197
+ | `deepEqual(a, b)` | function | Recursive deep equality comparison. Handles references, null/undefined, primitives, Arrays, Dates, and plain Objects. Used by `DataStore` for dirty tracking and selector cache stability. |
198
+ | `DEFAULT_DEBOUNCE_MS` | constant | Default debounce delay (300ms) used by `useDebouncedCallback`. |
199
+
200
+ ## Key Patterns
201
+
202
+ - **Mandatory + Optional hook pairs**: Every context exports both `useX()` (throws) and `useXOptional()` (returns null)
203
+ - **External store with selector-based subscriptions**: `DataStore` is a plain class; hooks subscribe via `useSyncExternalStore` + selector functions for fine-grained re-renders
204
+ - **Referential stability via deep-equal cache**: `useVisualBinding` and dynamic behavior hooks use ref-based caches with `deepEqual` to ensure referential stability for `useSyncExternalStore`
205
+ - **Model-driven binding**: `useVisualBinding` bridges `VisualElement` to `DataStore` by resolving `attributeType.name` as the data field key
206
+ - **Dynamic behavior via `*By` references**: `hiddenBy`/`enabledBy`/`requiredBy` properties on `VisualElement` reference `AttributeType` instances — hooks subscribe to the DataStore for those boolean fields and evaluate runtime visibility/disabled/required state
207
+ - **`enabledBy` vs `hiddenBy` asymmetry**: `enabledBy` fully replaces the static `disabled` value when present; `hiddenBy` only overrides _to hidden_ (never clears static `hidden=true`)
208
+ - **Dialog lifecycle with callbacks**: `openDialog` accepts an `onClose?: DialogCloseCallback` callback; dialog close callbacks stored in a ref-based stack (`dialogCloseCallbackStackRef`)
209
+ - **React Router integration**: `NavigationProvider` optionally accepts `navigate` and `getRouteForPage` props
210
+ - **`useSyncExternalStore` throughout**: `ApplicationProvider`, all data hooks, dynamic behavior hooks, and customization data-reactive hooks use React 18+ tear-free external store pattern
211
+ - **RefreshSignalProvider**: Post-operation refresh signaling — ViewContainerRenderer increments a counter after operations; embedded components watch and re-dispatch their refresh logic
212
+ - **Customizations with HMR support**: `CustomizationsProvider` stores config in a ref and uses a version counter; when customizations identity changes, version bumps and consumers re-render
213
+ - **Selector selection via mutable ref**: `SelectorSelectionProvider` uses a `useRef` for selection state to avoid re-renders; value only read at dispatch time
@@ -0,0 +1,46 @@
1
+ import { Application } from '@judo/model-api';
2
+ import { ModelRegistry } from '@judo/model-loader';
3
+ import { ReactNode } from 'react';
4
+ /**
5
+ * Application context type.
6
+ */
7
+ export interface ApplicationContextType {
8
+ /** Current active application (model required) */
9
+ application: Application;
10
+ /** All available applications (multi-actor) */
11
+ applications: Application[];
12
+ /** Switch to different actor */
13
+ switchActor: (actorName: string) => void;
14
+ /** Switch to different actor with navigation callback */
15
+ switchActorWithNavigation: (actorName: string, onSwitch?: (app: Application) => void) => void;
16
+ /** Current actor name */
17
+ actorName: string;
18
+ }
19
+ /**
20
+ * Hook to access application context.
21
+ * Throws if used outside provider or without model.
22
+ *
23
+ * @returns ApplicationContextType
24
+ * @throws Error if used outside ApplicationProvider
25
+ */
26
+ export declare function useApplication(): ApplicationContextType;
27
+ /**
28
+ * Hook to access application context (optional).
29
+ * Returns null if not within provider instead of throwing.
30
+ *
31
+ * @returns ApplicationContextType | null
32
+ */
33
+ export declare function useApplicationOptional(): ApplicationContextType | null;
34
+ /**
35
+ * Props for ApplicationProvider.
36
+ */
37
+ export interface ApplicationProviderProps {
38
+ children: ReactNode;
39
+ registry: ModelRegistry;
40
+ }
41
+ /**
42
+ * Provider requiring loaded model.
43
+ * Uses useSyncExternalStore for proper subscription to registry changes.
44
+ */
45
+ export declare function ApplicationProvider({ children, registry }: ApplicationProviderProps): import("react/jsx-runtime").JSX.Element;
46
+ //# sourceMappingURL=application-context.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"application-context.d.ts","sourceRoot":"","sources":["../../src/contexts/application-context.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAoB,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,KAAK,SAAS,EAAgE,MAAM,OAAO,CAAC;AAErG;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC,kDAAkD;IAClD,WAAW,EAAE,WAAW,CAAC;IACzB,+CAA+C;IAC/C,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,gCAAgC;IAChC,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,yDAAyD;IACzD,yBAAyB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,IAAI,KAAK,IAAI,CAAC;IAC9F,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;CAClB;AAID;;;;;;GAMG;AACH,wBAAgB,cAAc,IAAI,sBAAsB,CASvD;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,sBAAsB,GAAG,IAAI,CAEtE;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,EAAE,aAAa,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,wBAAwB,2CA4BnF"}