@judo/actions 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 (84) hide show
  1. package/LICENSE +277 -0
  2. package/README.md +257 -0
  3. package/dist/api/constants.d.ts +27 -0
  4. package/dist/api/constants.d.ts.map +1 -0
  5. package/dist/api/index.d.ts +9 -0
  6. package/dist/api/index.d.ts.map +1 -0
  7. package/dist/api/judo-rest-api.d.ts +262 -0
  8. package/dist/api/judo-rest-api.d.ts.map +1 -0
  9. package/dist/api/model-converters.d.ts +29 -0
  10. package/dist/api/model-converters.d.ts.map +1 -0
  11. package/dist/api/path-builder.d.ts +50 -0
  12. package/dist/api/path-builder.d.ts.map +1 -0
  13. package/dist/api/transfer-deserializer.d.ts +46 -0
  14. package/dist/api/transfer-deserializer.d.ts.map +1 -0
  15. package/dist/api/transfer-serializer.d.ts +85 -0
  16. package/dist/api/transfer-serializer.d.ts.map +1 -0
  17. package/dist/api/types.d.ts +278 -0
  18. package/dist/api/types.d.ts.map +1 -0
  19. package/dist/handlers/autocomplete/autocomplete-handlers.d.ts +20 -0
  20. package/dist/handlers/autocomplete/autocomplete-handlers.d.ts.map +1 -0
  21. package/dist/handlers/autocomplete/index.d.ts +2 -0
  22. package/dist/handlers/autocomplete/index.d.ts.map +1 -0
  23. package/dist/handlers/crud/crud-handlers.d.ts +76 -0
  24. package/dist/handlers/crud/crud-handlers.d.ts.map +1 -0
  25. package/dist/handlers/crud/index.d.ts +2 -0
  26. package/dist/handlers/crud/index.d.ts.map +1 -0
  27. package/dist/handlers/form/form-handlers.d.ts +28 -0
  28. package/dist/handlers/form/form-handlers.d.ts.map +1 -0
  29. package/dist/handlers/form/index.d.ts +2 -0
  30. package/dist/handlers/form/index.d.ts.map +1 -0
  31. package/dist/handlers/index.d.ts +10 -0
  32. package/dist/handlers/index.d.ts.map +1 -0
  33. package/dist/handlers/navigation/index.d.ts +2 -0
  34. package/dist/handlers/navigation/index.d.ts.map +1 -0
  35. package/dist/handlers/navigation/navigation-handlers.d.ts +23 -0
  36. package/dist/handlers/navigation/navigation-handlers.d.ts.map +1 -0
  37. package/dist/handlers/operation/index.d.ts +2 -0
  38. package/dist/handlers/operation/index.d.ts.map +1 -0
  39. package/dist/handlers/operation/operation-handlers.d.ts +43 -0
  40. package/dist/handlers/operation/operation-handlers.d.ts.map +1 -0
  41. package/dist/handlers/other/index.d.ts +2 -0
  42. package/dist/handlers/other/index.d.ts.map +1 -0
  43. package/dist/handlers/other/other-handlers.d.ts +10 -0
  44. package/dist/handlers/other/other-handlers.d.ts.map +1 -0
  45. package/dist/handlers/relation/index.d.ts +2 -0
  46. package/dist/handlers/relation/index.d.ts.map +1 -0
  47. package/dist/handlers/relation/relation-handlers.d.ts +49 -0
  48. package/dist/handlers/relation/relation-handlers.d.ts.map +1 -0
  49. package/dist/handlers/selector/index.d.ts +2 -0
  50. package/dist/handlers/selector/index.d.ts.map +1 -0
  51. package/dist/handlers/selector/selector-handlers.d.ts +30 -0
  52. package/dist/handlers/selector/selector-handlers.d.ts.map +1 -0
  53. package/dist/handlers/table/index.d.ts +2 -0
  54. package/dist/handlers/table/index.d.ts.map +1 -0
  55. package/dist/handlers/table/table-handlers.d.ts +18 -0
  56. package/dist/handlers/table/table-handlers.d.ts.map +1 -0
  57. package/dist/hooks/index.d.ts +3 -0
  58. package/dist/hooks/index.d.ts.map +1 -0
  59. package/dist/hooks/use-action-dispatcher.d.ts +61 -0
  60. package/dist/hooks/use-action-dispatcher.d.ts.map +1 -0
  61. package/dist/hooks/use-action-handler.d.ts +29 -0
  62. package/dist/hooks/use-action-handler.d.ts.map +1 -0
  63. package/dist/index.d.ts +13 -0
  64. package/dist/index.d.ts.map +1 -0
  65. package/dist/index.js +1427 -0
  66. package/dist/index.js.map +1 -0
  67. package/dist/lifecycle/execute-with-lifecycle.d.ts +20 -0
  68. package/dist/lifecycle/execute-with-lifecycle.d.ts.map +1 -0
  69. package/dist/lifecycle/index.d.ts +2 -0
  70. package/dist/lifecycle/index.d.ts.map +1 -0
  71. package/dist/provider/api-context.d.ts +30 -0
  72. package/dist/provider/api-context.d.ts.map +1 -0
  73. package/dist/provider/index.d.ts +2 -0
  74. package/dist/provider/index.d.ts.map +1 -0
  75. package/dist/registry/action-handler-registry.d.ts +11 -0
  76. package/dist/registry/action-handler-registry.d.ts.map +1 -0
  77. package/dist/registry/index.d.ts +2 -0
  78. package/dist/registry/index.d.ts.map +1 -0
  79. package/dist/types-BsQmyhQI.js +14 -0
  80. package/dist/types-BsQmyhQI.js.map +1 -0
  81. package/dist/types-CbA9-fcJ.js +2 -0
  82. package/dist/types.d.ts +260 -0
  83. package/dist/types.d.ts.map +1 -0
  84. package/package.json +45 -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,257 @@
1
+ # @judo/actions
2
+
3
+ > Action handler system and REST API client for JUDO UI Runtime
4
+
5
+ ## Purpose
6
+
7
+ Provides the complete action handler system — a registry of **40 built-in action handler hooks** (navigation, CRUD, relation, operation, form, selector, autocomplete, table, and other), a full REST API client (`JudoRestApi`), transfer serialization, path building, a React context provider for the API, lifecycle composition for action overrides, and dispatcher/handler hooks for wiring actions to UI components.
8
+
9
+ ## Architecture Layer
10
+
11
+ **Layer 4 (Features)** — depends on `model-api`; consumed by `components` and `app-shell`.
12
+
13
+ ## Dependencies
14
+
15
+ - `@judo/model-api` — model type definitions (`Action`, `ActionDefinition`, `ClassType`, `RelationType`, etc.)
16
+ - `react ^19` — React (peer dependency)
17
+
18
+ > **Note:** While handlers conceptually use services from `core` (navigation, data store), `feedback` (dialogs, notifications), and `i18n` (translations), these are **not package dependencies**. Handlers receive these services at runtime through the `TypedActionHandlerContext` object passed to each handler invocation.
19
+
20
+ ## File Structure
21
+
22
+ ```
23
+ src/
24
+ ├── index.ts # Root barrel export
25
+ ├── types.ts # Core action types, interfaces, context shapes
26
+ ├── api/
27
+ │ ├── types.ts # REST API types (HTTP, serialization, validation, query)
28
+ │ ├── constants.ts # REST header names and URL suffixes
29
+ │ ├── transfer-serializer.ts # Default transfer serializer (strips internal props)
30
+ │ ├── judo-rest-api.ts # JudoRestApi class (~870 lines) - full REST client
31
+ │ ├── model-converters.ts # Convert model types → REST metadata (internal)
32
+ │ └── path-builder.ts # REST URL path construction
33
+ ├── hooks/
34
+ │ ├── use-action-dispatcher.ts # useActionDispatcher hook
35
+ │ └── use-action-handler.ts # useActionHandler hook + hasActionHandler
36
+ ├── provider/
37
+ │ └── api-context.tsx # ApiProvider + useApi context
38
+ ├── registry/
39
+ │ └── action-handler-registry.ts # Maps 40 action types → handler hooks
40
+ ├── lifecycle/
41
+ │ └── execute-with-lifecycle.ts # Lifecycle composition engine (before/execute/after/onError)
42
+ └── handlers/
43
+ ├── navigation/ # 4 handlers
44
+ ├── form/ # 3 handlers
45
+ ├── selector/ # 5 handlers
46
+ ├── crud/ # 7 handlers
47
+ ├── relation/ # 8 handlers
48
+ ├── table/ # 3 handlers
49
+ ├── operation/ # 5 handlers
50
+ ├── autocomplete/ # 3 handlers
51
+ └── other/ # 2 handlers
52
+ ```
53
+
54
+ ## Exports Summary
55
+
56
+ ### Core Action Types
57
+
58
+ | Export | Kind | Description |
59
+ | --------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
60
+ | `ActionType` | type | Union of 40 string literals — all action definition type names. |
61
+ | `DialogCloseResultType` | type | `"cancelled" \| "created" \| "updated" \| "deleted" \| "selected" \| "submitted"` |
62
+ | `DialogCloseResult` | type | Discriminated union for dialog/action outcomes. |
63
+ | `TypedActionHandlerContext` | interface | Runtime context: `transfer`, `selectedRows`, `closeDialog`, `navigation`, `data`, `registry`, `validation`, `notifications`, `isEager`, `pageType`, `isEditMode`, `isPageAction`, `createDialog`, `onDialogClose`. |
64
+ | `ActionHandlerHookWithMeta` | interface | Typed handler hook with `.actionType` metadata property for registration. |
65
+ | `ActionHandlerFactoryProperties` | interface | Custom handler registration properties (by `sourceId`). |
66
+ | `BuiltInActionHandlerFactoryProperties` | interface | Built-in handler registration properties (by `actionType`). |
67
+ | `ACTION_HANDLER_FACTORY` | symbol | Service symbol for DI registration (re-exported from `model-api`). |
68
+
69
+ ### Lifecycle
70
+
71
+ | Export | Kind | Description |
72
+ | ---------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------- |
73
+ | `executeWithLifecycle(defaultHandler, overrides, baseContext, action)` | function | Composes lifecycle overrides (before/execute/after/onError) around a default handler. |
74
+
75
+ ### REST API Client
76
+
77
+ | Export | Kind | Description |
78
+ | --------------------------- | --------- | ---------------------------------------------------------------------------------------------- |
79
+ | `JudoRestApi` (class) | class | Full REST client (~870 lines) with 25+ methods covering all JUDO REST operations. |
80
+ | `createJudoRestApi(config)` | function | Factory function for `JudoRestApi`. |
81
+ | `JudoRestApiConfig` | interface | Config: `baseUrl`, `application: Application`, optional interceptors, serializer/deserializer. |
82
+
83
+ **Key REST methods:**
84
+
85
+ | Method | REST Endpoint | Description |
86
+ | ------------------------------------------------------- | -------------------------------------- | --------------------------------------------- |
87
+ | `getTemplate(classType)` | `GET /{classPath}/~template` | Fetch template for new transfer |
88
+ | `refresh(classType, target, qc?)` | `POST /{classPath}/~get` | Refresh stored transfer by signed ID |
89
+ | `update(classType, target, mask?)` | `POST /{classPath}/~update` | Update existing transfer |
90
+ | `validateUpdate(classType, target)` | `POST /{classPath}/~validate` | Server-side update validation |
91
+ | `delete(classType, target)` | `POST /{classPath}/~delete` | Delete transfer |
92
+ | `listRelation(relation, owner?, qc?, countRecords?)` | `POST /…/{relation}/~list` | List transfers in relation |
93
+ | `getRelation(relation, owner, qc?)` | `POST /…/{relation}/~get` | Get single-valued relation |
94
+ | `refreshAccessRelation(relation, qc?)` | `POST /…/{relation}/~get` | Get non-collection access relation (no owner) |
95
+ | `getRelationRange(relation, owner?, qc?)` | `POST /…/{relation}/~range` | Fetch range for selectors |
96
+ | `getRelationTemplate(relation)` | `GET /{targetClassPath}/~template` | Get template for relation target |
97
+ | `createRelation(relation, owner, data, mask?)` | `POST /…/~create` | Create transfer in relation |
98
+ | `validateCreateRelation(relation, owner, data)` | `POST /…/~validate` | Validate create before persisting |
99
+ | `setRelation(relation, owner, selected)` | `POST /…/~update/{relation}/~set` | Set single-valued relation |
100
+ | `unsetRelation(relation, owner)` | `POST /…/~update/{relation}/~unset` | Clear single-valued relation |
101
+ | `addToRelation(relation, owner, selected)` | `POST /…/~update/{relation}/~add` | Add to collection relation |
102
+ | `removeFromRelation(relation, owner, selected)` | `POST /…/~update/{relation}/~remove` | Remove from collection relation |
103
+ | `exportRelation(relation, owner?, qc?)` | `POST /…/{relation}/~export` | Export relation data as blob |
104
+ | `invokeOperation(classType, op, owner?, input?)` | `POST /{classPath}/{opName}` | Invoke operation |
105
+ | `validateOperationInput(classType, op, owner?, input?)` | `POST /{classPath}/{opName}/~validate` | Validate operation input |
106
+ | `getOperationInputTemplate(operation)` | `GET /{inputClassPath}/~template` | Get template for operation input |
107
+ | `getOperationInputRange(classType, op, owner?, qc?)` | `POST /{classPath}/{opName}/~range` | Fetch range for operation selector |
108
+ | `getPrincipal()` | `GET /{actorPath}/~principal` | Get current principal |
109
+ | `getMetadata()` | `GET /{actorPath}/~meta` | Get application metadata |
110
+ | `uploadFile(attributePath, file)` | Two-step upload with token | Upload binary data |
111
+ | `downloadFile(downloadToken, disposition?)` | `GET /download?disposition=…` | Download binary data |
112
+ | `findInstance(relation, identifier, mask?)` | `POST /…/{relation}/~list` | Find transfer by business identifier |
113
+
114
+ ### Transfer Serialization (internal to `api/` module)
115
+
116
+ These are exported from `api/index.ts` but **not** from the package's main entry point:
117
+
118
+ | Export | Kind | Description |
119
+ | ------------------------------- | ------------ | ---------------------------------------------------------------------------------------------- |
120
+ | `BACKEND_PROPERTIES` | constant Set | `__identifier`, `__entityType`, `__deleteable`, `__updateable`, `__version` — never send back. |
121
+ | `FRONTEND_PROPERTIES` | constant Set | `__tempId`, `__isNew`, `__items` — client-only, never serialize. |
122
+ | `INTERNAL_PROPERTIES` | constant Set | Union of both sets. |
123
+ | `isInternalProperty(key)` | function | Returns true for any internal prop (keeps `__signedIdentifier`). |
124
+ | `stripInternalProperties(data)` | function | Creates a new object without internal props. |
125
+ | `defaultTransferSerializer` | constant | Serializer that strips top-level internal properties (handles arrays by mapping). |
126
+
127
+ ### Path Building
128
+
129
+ | Function | Description |
130
+ | ------------------------------------------------------------------- | ---------------------------------------------------- |
131
+ | `getPathForActor(application, path?)` | Builds `/{modelName}/{actorPath}{path}` |
132
+ | `getRelationPath(relation, application, suffix)` | REST path for relation read endpoints |
133
+ | `getClassPath(classType, application, suffix)` | REST path for class endpoints |
134
+ | `getMutationRelationPath(relation, application, suffix, isAccess?)` | Mutation path with `/~update/` prefix for non-access |
135
+ | `getOperationPath(classType, operationName, application, suffix?)` | REST path for operation invocations |
136
+
137
+ ### API Validation
138
+
139
+ | Export | Kind | Description |
140
+ | ------------------------- | --------- | ----------------------------------------------------------------------------- |
141
+ | `ValidationError` (class) | class | Extends `Error` with `status`, `feedbackItems`, and `toFieldErrors()` method. |
142
+ | `FeedbackItem` | interface | `{ code, level, location, message }` from server responses. |
143
+
144
+ ### React Hooks
145
+
146
+ | Hook | Description |
147
+ | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
148
+ | `useActionDispatcher(options)` | Returns `{ dispatch, canHandle }`. Resolves handlers from registry, builds context, calls handlers. Supports lifecycle overrides via `actionOverrides` option. |
149
+ | `useActionHandler(action)` | Returns the handler function for a single action. Throws if no handler found. |
150
+ | `hasActionHandler(action)` | Checks whether a handler exists in the registry. |
151
+
152
+ ### React Provider
153
+
154
+ | Export | Kind | Description |
155
+ | ------------- | --------- | ----------------------------------------------------- |
156
+ | `ApiProvider` | component | Provides `JudoRestApi` via React context. |
157
+ | `useApi()` | hook | Consumes the API context; throws if outside provider. |
158
+
159
+ ### Built-in Action Handler Hooks (40 total)
160
+
161
+ #### Navigation (4)
162
+
163
+ | Handler | Action Type | Description |
164
+ | ----------------------------- | ----------------------------- | --------------------------------------------------------------------- |
165
+ | `useBackActionHandler` | `BackActionDefinition` | Closes dialog if open, otherwise `goBack` |
166
+ | `useOpenPageActionHandler` | `OpenPageActionDefinition` | Navigates to target page with transfer params; forwards eager context |
167
+ | `useRowOpenPageActionHandler` | `RowOpenPageActionDefinition` | Same as above but for table row clicks |
168
+ | `useCancelActionHandler` | `CancelActionDefinition` | Closes dialog → or resets transfer (VIEW edit mode) → or goBack |
169
+
170
+ #### Form (3)
171
+
172
+ | Handler | Action Type | Description |
173
+ | ---------------------------------------- | ---------------------------------------- | ---------------------------------------------------------------------- |
174
+ | `useOpenFormActionHandler` | `OpenFormActionDefinition` | Opens form dialog for editing |
175
+ | `useOpenCreateFormActionHandler` | `OpenCreateFormActionDefinition` | Opens create form dialog; supports eager/lazy modes with onDialogClose |
176
+ | `useOpenOperationInputFormActionHandler` | `OpenOperationInputFormActionDefinition` | Opens form for operation input parameters |
177
+
178
+ #### Selector (5)
179
+
180
+ | Handler | Action Type | Description |
181
+ | -------------------------------------------- | -------------------------------------------- | ------------------------------------------------ |
182
+ | `useOpenSelectorActionHandler` | `OpenSelectorActionDefinition` | Opens single-selection dialog |
183
+ | `useOpenAddSelectorActionHandler` | `OpenAddSelectorActionDefinition` | Opens multi-selection dialog for add |
184
+ | `useOpenSetSelectorActionHandler` | `OpenSetSelectorActionDefinition` | Opens selection dialog for set |
185
+ | `useOpenOperationInputSelectorActionHandler` | `OpenOperationInputSelectorActionDefinition` | Opens selector for operation input |
186
+ | `useSelectorRangeActionHandler` | `SelectorRangeActionDefinition` | Fetches range data via REST (or legacy callback) |
187
+
188
+ #### CRUD (7)
189
+
190
+ | Handler | Action Type | Description |
191
+ | ----------------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
192
+ | `useRefreshActionHandler` | `RefreshActionDefinition` | Four modes: access relation list, transfer relation list, selector range, single transfer refresh. Eager mode seeds from parent store. |
193
+ | `useCreateActionHandler` | `CreateActionDefinition` | Eager (local with validation) or lazy (REST) create with validation flow |
194
+ | `useUpdateActionHandler` | `UpdateActionDefinition` | Eager (parent update) or lazy (REST update + refresh). Reads transfer from data store via `pageTransferId`. |
195
+ | `useDeleteActionHandler` | `DeleteActionDefinition` | REST delete, clears from store, navigates back |
196
+ | `useBulkDeleteActionHandler` | `BulkDeleteActionDefinition` | Deletes all selected rows via parallel REST calls |
197
+ | `useRowDeleteActionHandler` | `RowDeleteActionDefinition` | Eager (remove from parent) or lazy (REST delete) single row |
198
+ | `useGetTemplateActionHandler` | `GetTemplateActionDefinition` | Fetches default values via REST; stores at `pageTransferId` |
199
+
200
+ #### Relation (8)
201
+
202
+ | Handler | Action Type | Description |
203
+ | --------------------------------- | --------------------------------- | ------------------------------------------------------------ |
204
+ | `useSetActionHandler` | `SetActionDefinition` | Sets single-valued relation; closes dialog with `"selected"` |
205
+ | `useUnsetActionHandler` | `UnsetActionDefinition` | Clears single-valued relation |
206
+ | `useAddActionHandler` | `AddActionDefinition` | Adds to collection relation; closes dialog with `"selected"` |
207
+ | `useRemoveActionHandler` | `RemoveActionDefinition` | Eager (remove from parent array) or lazy (REST remove) |
208
+ | `useBulkRemoveActionHandler` | `BulkRemoveActionDefinition` | Eager or lazy removal of multiple selected transfers |
209
+ | `useClearActionHandler` | `ClearActionDefinition` | Clears all transfers from relation via `unsetRelation` |
210
+ | `useRefreshRelationActionHandler` | `RefreshRelationActionDefinition` | Refreshes relation data (list or get based on cardinality) |
211
+ | `useFilterRelationActionHandler` | `FilterRelationActionDefinition` | Signals filter intent via `onFilterRelation` callback |
212
+
213
+ #### Table (3)
214
+
215
+ | Handler | Action Type | Description |
216
+ | --------------------------------- | --------------------------------- | ------------------------------------------------------------ |
217
+ | `useFilterActionHandler` | `FilterActionDefinition` | Signals filter intent via `onFilterRequest` callback |
218
+ | `useExportActionHandler` | `ExportActionDefinition` | Exports via REST, triggers browser download |
219
+ | `useInlineCreateRowActionHandler` | `InlineCreateRowActionDefinition` | Signals inline row creation via `onInlineCreateRow` callback |
220
+
221
+ #### Operation (5)
222
+
223
+ | Handler | Action Type | Description |
224
+ | -------------------------------------------- | -------------------------------------------- | ---------------------------------------------------------------------------- |
225
+ | `useCallOperationActionHandler` | `CallOperationActionDefinition` | Invokes bound operation via REST; opens output dialog if result + targetPage |
226
+ | `useBulkCallOperationActionHandler` | `BulkCallOperationActionDefinition` | Invokes operation on each selected row in parallel |
227
+ | `useInputFormCallOperationActionHandler` | `InputFormCallOperationActionDefinition` | Invokes operation with form input; closes dialog only on success |
228
+ | `useInputSelectorCallOperationActionHandler` | `InputSelectorCallOperationActionDefinition` | Invokes operation with selected transfer; closes dialog only on success |
229
+ | `useParameterlessCallOperationActionHandler` | `ParameterlessCallOperationActionDefinition` | Invokes operation with no input |
230
+
231
+ #### Autocomplete (3)
232
+
233
+ | Handler | Action Type | Description |
234
+ | ----------------------------------- | ----------------------------------- | ----------------------------------------------- |
235
+ | `useAutocompleteRangeActionHandler` | `AutocompleteRangeActionDefinition` | Fetches range for autocomplete with search text |
236
+ | `useAutocompleteSetActionHandler` | `AutocompleteSetActionDefinition` | Sets single-valued relation via autocomplete |
237
+ | `useAutocompleteAddActionHandler` | `AutocompleteAddActionDefinition` | Adds to collection via autocomplete |
238
+
239
+ #### Other (2)
240
+
241
+ | Handler | Action Type | Description |
242
+ | -------------------------- | -------------------------- | ------------------------------------------ |
243
+ | `usePreFetchActionHandler` | `PreFetchActionDefinition` | Pre-fetches data via `onPreFetch` callback |
244
+ | `useCustomActionHandler` | `CustomActionDefinition` | Delegates to `onCustomAction` callback |
245
+
246
+ ## Key Patterns
247
+
248
+ - **Hook factory pattern**: Every handler is `(action) => (context) => Promise<void>`. React hooks at the outer level; async handler at the inner level.
249
+ - **Discriminated union dispatch**: Internal registry maps `@type` → handler hook. 40 entries cover all action types.
250
+ - **Eager vs Lazy**: CRUD and relation handlers distinguish between eager (local aggregated, no REST) and lazy (REST-persisted) modes.
251
+ - **Transfer serialization**: `defaultTransferSerializer` strips all `__*` properties except `__signedIdentifier`.
252
+ - **Validation error flow**: `ValidationError` auto-parses 400 responses. Handlers set field errors on `ValidationContext`.
253
+ - **Path construction**: `getRelationPath`/`getClassPath`/`getMutationRelationPath` compose REST URLs from model metadata.
254
+ - **Context casting**: Handlers cast `TypedActionHandlerContext` to local interfaces for mode-specific properties (eager, selector, API, legacy callbacks).
255
+ - **React context for API**: `ApiProvider`/`useApi` decouple handler instantiation from API configuration.
256
+ - **Lifecycle composition**: `executeWithLifecycle` wraps built-in handlers with before/execute/after/onError hooks for customization.
257
+ - **Legacy callback support**: All handlers support both legacy callbacks (on\*) and API mode, enabling incremental migration.
@@ -0,0 +1,27 @@
1
+ /**
2
+ * JUDO REST API constants.
3
+ * Based on REST_REQUEST_MAPPING_SPECIFICATION.md
4
+ */
5
+ export declare const HEADER_SIGNED_IDENTIFIER = "X-Judo-SignedIdentifier";
6
+ export declare const HEADER_MASK = "X-Judo-Mask";
7
+ export declare const HEADER_MARK_SELECTED_RANGE_ITEMS = "X-Judo-Mark-Selected-Range-Items";
8
+ export declare const HEADER_COUNT_RECORDS = "X-Judo-CountRecords";
9
+ export declare const HEADER_TOKEN = "X-Token";
10
+ export declare const DEFAULT_COMMAND_MASK = "{}";
11
+ export declare const SUFFIX_TEMPLATE = "/~template";
12
+ export declare const SUFFIX_GET = "/~get";
13
+ export declare const SUFFIX_UPDATE = "/~update";
14
+ export declare const SUFFIX_VALIDATE = "/~validate";
15
+ export declare const SUFFIX_DELETE = "/~delete";
16
+ export declare const SUFFIX_LIST = "/~list";
17
+ export declare const SUFFIX_RANGE = "/~range";
18
+ export declare const SUFFIX_CREATE = "/~create";
19
+ export declare const SUFFIX_SET = "/~set";
20
+ export declare const SUFFIX_UNSET = "/~unset";
21
+ export declare const SUFFIX_ADD = "/~add";
22
+ export declare const SUFFIX_REMOVE = "/~remove";
23
+ export declare const SUFFIX_EXPORT = "/~export";
24
+ export declare const SUFFIX_UPLOAD_TOKEN = "/~upload-token";
25
+ export declare const SUFFIX_PRINCIPAL = "/~principal";
26
+ export declare const SUFFIX_META = "/~meta";
27
+ //# sourceMappingURL=constants.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/api/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,eAAO,MAAM,wBAAwB,4BAA4B,CAAC;AAClE,eAAO,MAAM,WAAW,gBAAgB,CAAC;AACzC,eAAO,MAAM,gCAAgC,qCAAqC,CAAC;AACnF,eAAO,MAAM,oBAAoB,wBAAwB,CAAC;AAC1D,eAAO,MAAM,YAAY,YAAY,CAAC;AAGtC,eAAO,MAAM,oBAAoB,OAAO,CAAC;AAGzC,eAAO,MAAM,eAAe,eAAe,CAAC;AAC5C,eAAO,MAAM,UAAU,UAAU,CAAC;AAClC,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,eAAe,eAAe,CAAC;AAC5C,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC,eAAO,MAAM,YAAY,YAAY,CAAC;AACtC,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,UAAU,UAAU,CAAC;AAClC,eAAO,MAAM,YAAY,YAAY,CAAC;AACtC,eAAO,MAAM,UAAU,UAAU,CAAC;AAClC,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,mBAAmB,mBAAmB,CAAC;AACpD,eAAO,MAAM,gBAAgB,gBAAgB,CAAC;AAC9C,eAAO,MAAM,WAAW,WAAW,CAAC"}
@@ -0,0 +1,9 @@
1
+ export { JudoRestApi, createJudoRestApi } from './judo-rest-api';
2
+ export type { JudoRestApiConfig, OperationInfo } from './judo-rest-api';
3
+ export type { JudoRestResponse, TransferData, StrictTransferData, TransferStored, StrictTransferStored, QueryCustomizer, RangeRequestBody, HttpMethod, ResponseType, DeserializationType, ServiceType, ResponseDeserializerConfig, TransferSerializer, TransferDeserializer, TemporalFieldType, TemporalFieldRegistry, FeedbackItem, DialogResult, OnDialogSubmit, OnDialogValidate, } from './types';
4
+ export { ValidationError } from './types';
5
+ export { getPathForActor, getRelationPath, getClassPath, getMutationRelationPath, getOperationPath, } from './path-builder';
6
+ export { HEADER_SIGNED_IDENTIFIER, HEADER_MASK, HEADER_MARK_SELECTED_RANGE_ITEMS, HEADER_TOKEN, DEFAULT_COMMAND_MASK, SUFFIX_TEMPLATE, SUFFIX_GET, SUFFIX_UPDATE, SUFFIX_VALIDATE, SUFFIX_DELETE, SUFFIX_LIST, SUFFIX_RANGE, SUFFIX_CREATE, SUFFIX_SET, SUFFIX_UNSET, SUFFIX_ADD, SUFFIX_REMOVE, SUFFIX_EXPORT, } from './constants';
7
+ export { defaultTransferSerializer, createModelAwareSerializer, serializeTemporalValue, stripInternalProperties, isInternalProperty, INTERNAL_PROPERTIES, BACKEND_PROPERTIES, FRONTEND_PROPERTIES, } from './transfer-serializer';
8
+ export { createModelAwareDeserializer, deserializeTemporalValue, parseLocalDate } from './transfer-deserializer';
9
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACjE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACxE,YAAY,EAEX,gBAAgB,EAEhB,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAEhB,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,WAAW,EAEX,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EAEpB,iBAAiB,EACjB,qBAAqB,EAErB,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,gBAAgB,GAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EACN,eAAe,EACf,eAAe,EACf,YAAY,EACZ,uBAAuB,EACvB,gBAAgB,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,wBAAwB,EACxB,WAAW,EACX,gCAAgC,EAChC,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,UAAU,EACV,aAAa,EACb,eAAe,EACf,aAAa,EACb,WAAW,EACX,YAAY,EACZ,aAAa,EACb,UAAU,EACV,YAAY,EACZ,UAAU,EACV,aAAa,EACb,aAAa,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,yBAAyB,EACzB,0BAA0B,EAC1B,sBAAsB,EACtB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC"}