@genesislcap/foundation-forms 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.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 (39) hide show
  1. package/dist/dts/filters/filters.template.d.ts.map +1 -1
  2. package/dist/dts/form.d.ts +226 -272
  3. package/dist/dts/form.d.ts.map +1 -1
  4. package/dist/dts/form.styles.d.ts.map +1 -1
  5. package/dist/dts/form.template.d.ts.map +1 -1
  6. package/dist/dts/jsonforms/json-forms.d.ts.map +1 -1
  7. package/dist/dts/jsonforms/renderers/ArrayListWrapperRenderer.d.ts.map +1 -1
  8. package/dist/dts/jsonforms/renderers/BooleanControlRenderer.d.ts.map +1 -1
  9. package/dist/dts/jsonforms/renderers/CategorizationWrapperRenderer.d.ts.map +1 -1
  10. package/dist/dts/jsonforms/renderers/ConnectedMultiselectControlRenderer.d.ts.map +1 -1
  11. package/dist/dts/jsonforms/renderers/ConnectedSelectControlRenderer.d.ts.map +1 -1
  12. package/dist/dts/jsonforms/renderers/DateControlRenderer.d.ts.map +1 -1
  13. package/dist/dts/jsonforms/renderers/EnumControlRenderer.d.ts.map +1 -1
  14. package/dist/dts/jsonforms/renderers/FilterDateControlRenderer.d.ts.map +1 -1
  15. package/dist/dts/jsonforms/renderers/FilterNumberControlRenderer.d.ts.map +1 -1
  16. package/dist/dts/jsonforms/renderers/FilterTimeControlRenderer.d.ts.map +1 -1
  17. package/dist/dts/jsonforms/renderers/NumberControlRenderer.d.ts.map +1 -1
  18. package/dist/dts/jsonforms/renderers/StepperWrapperRenderer.d.ts.map +1 -1
  19. package/dist/dts/jsonforms/renderers/StringArrayControlRenderer.d.ts.map +1 -1
  20. package/dist/dts/jsonforms/renderers/StringControlRenderer.d.ts.map +1 -1
  21. package/dist/dts/jsonforms/testers/isArray.d.ts.map +1 -1
  22. package/dist/dts/jsonforms/testers/optionIs.d.ts.map +1 -1
  23. package/dist/dts/tsdoc-metadata.json +1 -1
  24. package/dist/dts/utils/filters.d.ts.map +1 -1
  25. package/dist/dts/utils/validation.d.ts.map +1 -1
  26. package/dist/esm/filters/filters.js +1 -1
  27. package/dist/esm/form.js +1 -1
  28. package/dist/foundation-forms.api.json +11 -29
  29. package/dist/foundation-forms.d.ts +226 -272
  30. package/docs/api/foundation-forms.filters.filternamechanged.md +4 -45
  31. package/docs/api/foundation-forms.filters.loadfilterdata.md +3 -31
  32. package/docs/api/foundation-forms.filters.md +21 -314
  33. package/docs/api/foundation-forms.form.md +14 -224
  34. package/docs/api/foundation-forms.form.reset.md +3 -33
  35. package/docs/api/foundation-forms.md +28 -293
  36. package/docs/api/foundation-forms.mustmatch.md +1 -44
  37. package/docs/api/index.md +3 -21
  38. package/package.json +19 -17
  39. package/docs/api-report.md.api.md +0 -302
package/docs/api/foundation-forms.md CHANGED
@@ -6,303 +6,38 @@
6
6
 
7
7
  ## Classes
8
8
 
9
- <table><thead><tr><th>
10
-
11
- Class
12
-
13
-
14
- </th><th>
15
-
16
- Description
17
-
18
-
19
- </th></tr></thead>
20
- <tbody><tr><td>
21
-
22
- [Filters](./foundation-forms.filters.md)
23
-
24
-
25
- </td><td>
26
-
27
- Foundation filters component for automatically generated filters based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable filters elements using UI schema and set of custom renderers
28
-
29
-
30
- </td></tr>
31
- <tr><td>
32
-
33
- [Form](./foundation-forms.form.md)
34
-
35
-
36
- </td><td>
37
-
38
- Foundation form component for automatically generated forms based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable form elements using UI schema and set of custom renderers
39
-
40
-
41
- </td></tr>
42
- </tbody></table>
43
-
44
- ## Functions
45
-
46
- <table><thead><tr><th>
47
-
48
- Function
49
-
50
-
51
- </th><th>
52
-
53
- Description
54
-
55
-
56
- </th></tr></thead>
57
- <tbody><tr><td>
58
-
59
- [mustMatch(target)](./foundation-forms.mustmatch.md)
60
-
61
-
62
- </td><td>
63
-
64
- Ensures the value of the current field (the one the validator is on) matches the one of the target field.
65
-
66
-
67
- </td></tr>
68
- </tbody></table>
9
+ | Class | Description |
10
+ | --- | --- |
11
+ | [Filters](./foundation-forms.filters.md) | Foundation filters component for automatically generated filters based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable filters elements using UI schema and set of custom renderers |
12
+ | [Form](./foundation-forms.form.md) | Foundation form component for automatically generated forms based on json schema obtained from the api, supplied initial data or supplied JSON schema. Allowing customisable form elements using UI schema and set of custom renderers |
69
13
 
70
14
  ## Variables
71
15
 
72
- <table><thead><tr><th>
73
-
74
- Variable
75
-
76
-
77
- </th><th>
78
-
79
- Description
80
-
81
-
82
- </th></tr></thead>
83
- <tbody><tr><td>
84
-
85
- [filtersRenderers](./foundation-forms.filtersrenderers.md)
86
-
87
-
88
- </td><td>
89
-
90
- Set of default renderers used by the foundation-filters.
91
-
92
-
93
- </td></tr>
94
- <tr><td>
95
-
96
- [renderers](./foundation-forms.renderers.md)
97
-
98
-
99
- </td><td>
100
-
101
- Set of default renderers used by the foundation-forms.
102
-
103
-
104
- </td></tr>
105
- </tbody></table>
16
+ | Variable | Description |
17
+ | --- | --- |
18
+ | [filtersRenderers](./foundation-forms.filtersrenderers.md) | Set of default renderers used by the foundation-filters. |
19
+ | [mustMatch](./foundation-forms.mustmatch.md) | Ensures the value of the current field (the one the validator is on) matches the one of the target field. |
20
+ | [renderers](./foundation-forms.renderers.md) | Set of default renderers used by the foundation-forms. |
106
21
 
107
22
  ## Type Aliases
108
23
 
109
- <table><thead><tr><th>
110
-
111
- Type Alias
112
-
113
-
114
- </th><th>
115
-
116
- Description
117
-
118
-
119
- </th></tr></thead>
120
- <tbody><tr><td>
121
-
122
- [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md)
123
-
124
-
125
- </td><td>
126
-
127
- Configuration options available for array renderer.
128
-
129
-
130
- </td></tr>
131
- <tr><td>
132
-
133
- [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
134
-
135
-
136
- </td><td>
137
-
138
- Configuration options available for categorization renderer.
139
-
140
-
141
- </td></tr>
142
- <tr><td>
143
-
144
- [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md)
145
-
146
-
147
- </td><td>
148
-
149
- Available configuration options for connected combobox/multiselect.
150
-
151
-
152
- </td></tr>
153
- <tr><td>
154
-
155
- [GroupRendererOptions](./foundation-forms.grouprendereroptions.md)
156
-
157
-
158
- </td><td>
159
-
160
- Configuration options available for group renderer.
161
-
162
-
163
- </td></tr>
164
- <tr><td>
165
-
166
- [LabelPlacementOptions](./foundation-forms.labelplacementoptions.md)
167
-
168
-
169
- </td><td>
170
-
171
- Orientation options available for stepper renderer.
172
-
173
-
174
- </td></tr>
175
- <tr><td>
176
-
177
- [LabelPlacementType](./foundation-forms.labelplacementtype.md)
178
-
179
-
180
- </td><td>
181
-
182
- Available aligment for labels.
183
-
184
-
185
- </td></tr>
186
- <tr><td>
187
-
188
- [RendererEntry](./foundation-forms.rendererentry.md)
189
-
190
-
191
- </td><td>
192
-
193
- Defines a renderer configuration in JSON forms. Allows to specify the renderer component, a tester function to determine renderer applicability, and a mapper function to connect JSON forms state to renderer's props.
194
-
195
-
196
- </td></tr>
197
- <tr><td>
198
-
199
- [StandardRendererOptions](./foundation-forms.standardrendereroptions.md)
200
-
201
-
202
- </td><td>
203
-
204
- Standard configuration options available for all renderers.
205
-
206
-
207
- </td></tr>
208
- <tr><td>
209
-
210
- [StepperOrientationOptions](./foundation-forms.stepperorientationoptions.md)
211
-
212
-
213
- </td><td>
214
-
215
- Orientation options available for stepper renderer.
216
-
217
-
218
- </td></tr>
219
- <tr><td>
220
-
221
- [StepperOrientationType](./foundation-forms.stepperorientationtype.md)
222
-
223
-
224
- </td><td>
225
-
226
- Available orientation for stepper renderer.
227
-
228
-
229
- </td></tr>
230
- <tr><td>
231
-
232
- [StepperRendererOptions](./foundation-forms.stepperrendereroptions.md)
233
-
234
-
235
- </td><td>
236
-
237
- Configuration options available for stepper renderer.
238
-
239
-
240
- </td></tr>
241
- <tr><td>
242
-
243
- [StringRendererOptions](./foundation-forms.stringrendereroptions.md)
244
-
245
-
246
- </td><td>
247
-
248
- Configuration options available for string renderer.
249
-
250
-
251
- </td></tr>
252
- <tr><td>
253
-
254
- [UiSchema](./foundation-forms.uischema.md)
255
-
256
-
257
- </td><td>
258
-
259
- The UI schema, which is passed to JSON Forms, describes the general layout of a form and is just a regular JSON object. It describes the form by means of different UI schema elements, which can often be categorized into either Controls or Layouts.
260
-
261
-
262
- </td></tr>
263
- <tr><td>
264
-
265
- [UiSchemaElement](./foundation-forms.uischemaelement.md)
266
-
267
-
268
- </td><td>
269
-
270
- A UiSchemaElement that displays property values in a user interface element.
271
-
272
-
273
- </td></tr>
274
- <tr><td>
275
-
276
- [UiSchemaElementOptions](./foundation-forms.uischemaelementoptions.md)
277
-
278
-
279
- </td><td>
280
-
281
- All configuration options that are available.
282
-
283
-
284
- </td></tr>
285
- <tr><td>
286
-
287
- [UiSchemaElementType](./foundation-forms.uischemaelementtype.md)
288
-
289
-
290
- </td><td>
291
-
292
- The layouts and control types, which allow you to customize the arrangement of forms.
293
-
294
-
295
- </td></tr>
296
- <tr><td>
297
-
298
- [UiSchemaOptions](./foundation-forms.uischemaoptions.md)
299
-
300
-
301
- </td><td>
302
-
303
- All configuration options that are available.
304
-
305
-
306
- </td></tr>
307
- </tbody></table>
24
+ | Type Alias | Description |
25
+ | --- | --- |
26
+ | [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md) | Configuration options available for array renderer. |
27
+ | [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md) | Configuration options available for categorization renderer. |
28
+ | [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md) | Available configuration options for connected combobox/multiselect. |
29
+ | [GroupRendererOptions](./foundation-forms.grouprendereroptions.md) | Configuration options available for group renderer. |
30
+ | [LabelPlacementOptions](./foundation-forms.labelplacementoptions.md) | Orientation options available for stepper renderer. |
31
+ | [LabelPlacementType](./foundation-forms.labelplacementtype.md) | Available aligment for labels. |
32
+ | [RendererEntry](./foundation-forms.rendererentry.md) | Defines a renderer configuration in JSON forms. Allows to specify the renderer component, a tester function to determine renderer applicability, and a mapper function to connect JSON forms state to renderer's props. |
33
+ | [StandardRendererOptions](./foundation-forms.standardrendereroptions.md) | Standard configuration options available for all renderers. |
34
+ | [StepperOrientationOptions](./foundation-forms.stepperorientationoptions.md) | Orientation options available for stepper renderer. |
35
+ | [StepperOrientationType](./foundation-forms.stepperorientationtype.md) | Available orientation for stepper renderer. |
36
+ | [StepperRendererOptions](./foundation-forms.stepperrendereroptions.md) | Configuration options available for stepper renderer. |
37
+ | [StringRendererOptions](./foundation-forms.stringrendereroptions.md) | Configuration options available for string renderer. |
38
+ | [UiSchema](./foundation-forms.uischema.md) | The UI schema, which is passed to JSON Forms, describes the general layout of a form and is just a regular JSON object. It describes the form by means of different UI schema elements, which can often be categorized into either Controls or Layouts. |
39
+ | [UiSchemaElement](./foundation-forms.uischemaelement.md) | A UiSchemaElement that displays property values in a user interface element. |
40
+ | [UiSchemaElementOptions](./foundation-forms.uischemaelementoptions.md) | All configuration options that are available. |
41
+ | [UiSchemaElementType](./foundation-forms.uischemaelementtype.md) | The layouts and control types, which allow you to customize the arrangement of forms. |
42
+ | [UiSchemaOptions](./foundation-forms.uischemaoptions.md) | All configuration options that are available. |
308
43
 
package/docs/api/foundation-forms.mustmatch.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [mustMatch](./foundation-forms.mustmatch.md)
4
4
 
5
- ## mustMatch() function
5
+ ## mustMatch variable
6
6
 
7
7
  Ensures the value of the current field (the one the validator is on) matches the one of the target field.
8
8
 
@@ -17,46 +17,3 @@ mustMatch: (target: string) => (data: any, path: any, label: any) => {
17
17
  params: {};
18
18
  }[]
19
19
  ```
20
-
21
- ## Parameters
22
-
23
- <table><thead><tr><th>
24
-
25
- Parameter
26
-
27
-
28
- </th><th>
29
-
30
- Type
31
-
32
-
33
- </th><th>
34
-
35
- Description
36
-
37
-
38
- </th></tr></thead>
39
- <tbody><tr><td>
40
-
41
- target
42
-
43
-
44
- </td><td>
45
-
46
- string
47
-
48
-
49
- </td><td>
50
-
51
- any other field
52
-
53
-
54
- </td></tr>
55
- </tbody></table>
56
-
57
- **Returns:**
58
-
59
- (data: any, path: any, label: any) =&gt; { instancePath: string; message: string; schemaPath: string; keyword: string; params: {}; }\[\]
60
-
61
- a validator function that will be run by the smart form during the client-side validation stage
62
-
package/docs/api/index.md CHANGED
@@ -6,25 +6,7 @@
6
6
 
7
7
  ## Packages
8
8
 
9
- <table><thead><tr><th>
10
-
11
- Package
12
-
13
-
14
- </th><th>
15
-
16
- Description
17
-
18
-
19
- </th></tr></thead>
20
- <tbody><tr><td>
21
-
22
- [@genesislcap/foundation-forms](./foundation-forms.md)
23
-
24
-
25
- </td><td>
26
-
27
-
28
- </td></tr>
29
- </tbody></table>
9
+ | Package | Description |
10
+ | --- | --- |
11
+ | [@genesislcap/foundation-forms](./foundation-forms.md) | |
30
12
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-forms",
3
3
  "description": "Genesis Foundation Forms",
4
- "version": "14.302.1-alpha-475e82d.0",
4
+ "version": "14.302.1-alpha-ecc0cfb.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -48,22 +48,23 @@
48
48
  }
49
49
  },
50
50
  "devDependencies": {
51
- "@genesislcap/foundation-testing": "14.302.1-alpha-475e82d.0",
52
- "@genesislcap/genx": "14.302.1-alpha-475e82d.0",
53
- "@genesislcap/rollup-builder": "14.302.1-alpha-475e82d.0",
54
- "@genesislcap/ts-builder": "14.302.1-alpha-475e82d.0",
55
- "@genesislcap/uvu-playwright-builder": "14.302.1-alpha-475e82d.0",
56
- "@genesislcap/vite-builder": "14.302.1-alpha-475e82d.0",
57
- "@genesislcap/webpack-builder": "14.302.1-alpha-475e82d.0",
58
- "@types/json-schema": "^7.0.11"
51
+ "@genesislcap/foundation-testing": "14.302.1-alpha-ecc0cfb.0",
52
+ "@genesislcap/genx": "14.302.1-alpha-ecc0cfb.0",
53
+ "@genesislcap/rollup-builder": "14.302.1-alpha-ecc0cfb.0",
54
+ "@genesislcap/ts-builder": "14.302.1-alpha-ecc0cfb.0",
55
+ "@genesislcap/uvu-playwright-builder": "14.302.1-alpha-ecc0cfb.0",
56
+ "@genesislcap/vite-builder": "14.302.1-alpha-ecc0cfb.0",
57
+ "@genesislcap/webpack-builder": "14.302.1-alpha-ecc0cfb.0",
58
+ "@types/json-schema": "^7.0.11",
59
+ "rimraf": "^5.0.0"
59
60
  },
60
61
  "dependencies": {
61
- "@genesislcap/foundation-comms": "14.302.1-alpha-475e82d.0",
62
- "@genesislcap/foundation-criteria": "14.302.1-alpha-475e82d.0",
63
- "@genesislcap/foundation-logger": "14.302.1-alpha-475e82d.0",
64
- "@genesislcap/foundation-notifications": "14.302.1-alpha-475e82d.0",
65
- "@genesislcap/foundation-ui": "14.302.1-alpha-475e82d.0",
66
- "@genesislcap/foundation-utils": "14.302.1-alpha-475e82d.0",
62
+ "@genesislcap/foundation-comms": "14.302.1-alpha-ecc0cfb.0",
63
+ "@genesislcap/foundation-criteria": "14.302.1-alpha-ecc0cfb.0",
64
+ "@genesislcap/foundation-logger": "14.302.1-alpha-ecc0cfb.0",
65
+ "@genesislcap/foundation-notifications": "14.302.1-alpha-ecc0cfb.0",
66
+ "@genesislcap/foundation-ui": "14.302.1-alpha-ecc0cfb.0",
67
+ "@genesislcap/foundation-utils": "14.302.1-alpha-ecc0cfb.0",
67
68
  "@json-schema-tools/dereferencer": "^1.6.1",
68
69
  "@jsonforms/core": "^3.2.1",
69
70
  "@microsoft/fast-components": "2.30.6",
@@ -73,7 +74,8 @@
73
74
  "ajv": "8.16.0",
74
75
  "change-case": "^4.1.2",
75
76
  "json-schema": "^0.4.0",
76
- "lodash": "^4.17.21"
77
+ "lodash": "^4.17.21",
78
+ "tslib": "^2.3.1"
77
79
  },
78
80
  "repository": {
79
81
  "type": "git",
@@ -84,5 +86,5 @@
84
86
  "access": "public"
85
87
  },
86
88
  "customElements": "dist/custom-elements.json",
87
- "gitHead": "7ef53892e1de34f3e9c742e3ebd88d4880a27ca1"
89
+ "gitHead": "dad34f09069fa189f6d6855903eed9a431fdbab1"
88
90
  }