@genesislcap/foundation-forms 14.116.0 → 14.117.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 (23) hide show
  1. package/README.md +6 -6
  2. package/dist/dts/jsonforms/renderers/StringControlRenderer.d.ts.map +1 -1
  3. package/dist/dts/types.d.ts +165 -13
  4. package/dist/dts/types.d.ts.map +1 -1
  5. package/dist/esm/jsonforms/renderers/StringControlRenderer.js +30 -15
  6. package/dist/foundation-forms.api.json +290 -25
  7. package/dist/foundation-forms.d.ts +185 -25
  8. package/docs/api/foundation-forms.arrayrendereroptions.md +17 -0
  9. package/docs/api/foundation-forms.categorizationrendereroptions.md +17 -0
  10. package/docs/api/foundation-forms.connectedrenderersoptions.md +20 -0
  11. package/docs/api/foundation-forms.grouprendereroptions.md +15 -0
  12. package/docs/api/foundation-forms.md +13 -5
  13. package/docs/api/foundation-forms.standardrendereroptions.md +19 -0
  14. package/docs/api/foundation-forms.stepperorientationoptions.md +17 -0
  15. package/docs/api/foundation-forms.stepperorientationtype.md +1 -0
  16. package/docs/api/foundation-forms.stepperrendereroptions.md +15 -0
  17. package/docs/api/foundation-forms.stringrendereroptions.md +16 -0
  18. package/docs/api/foundation-forms.uischema.md +3 -2
  19. package/docs/api/foundation-forms.uischemaelement.md +1 -0
  20. package/docs/api/foundation-forms.uischemaelementoptions.md +3 -19
  21. package/docs/api/foundation-forms.uischemaelementtype.md +2 -1
  22. package/docs/api-report.md +55 -26
  23. package/package.json +9 -9
package/docs/api/foundation-forms.categorizationrendereroptions.md ADDED
@@ -0,0 +1,17 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
4
+
5
+ ## CategorizationRendererOptions type
6
+
7
+ Configuration options available for categorization renderer.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type CategorizationRendererOptions = {
13
+ childElements?: UiSchema[];
14
+ };
15
+ ```
16
+ **References:** [UiSchema](./foundation-forms.uischema.md)
17
+
package/docs/api/foundation-forms.connectedrenderersoptions.md ADDED
@@ -0,0 +1,20 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md)
4
+
5
+ ## ConnectedRenderersOptions type
6
+
7
+ Available configuration options for connected combobox/multiselect.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type ConnectedRenderersOptions = {
13
+ async?: boolean;
14
+ allOptionsResourceName?: string;
15
+ datasourceConfig?: DatasourceOptions;
16
+ valueField?: string;
17
+ labelField?: string;
18
+ data?: any[];
19
+ };
20
+ ```
package/docs/api/foundation-forms.grouprendereroptions.md ADDED
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [GroupRendererOptions](./foundation-forms.grouprendereroptions.md)
4
+
5
+ ## GroupRendererOptions type
6
+
7
+ Configuration options available for group renderer.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type GroupRendererOptions = CategorizationRendererOptions;
13
+ ```
14
+ **References:** [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
15
+
package/docs/api/foundation-forms.md CHANGED
@@ -25,10 +25,18 @@
25
25
 
26
26
  | Type Alias | Description |
27
27
  | --- | --- |
28
+ | [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md) | Configuration options available for array renderer. |
29
+ | [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md) | Configuration options available for categorization renderer. |
30
+ | [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md) | Available configuration options for connected combobox/multiselect. |
31
+ | [GroupRendererOptions](./foundation-forms.grouprendereroptions.md) | Configuration options available for group renderer. |
28
32
  | [RendererEntry](./foundation-forms.rendererentry.md) | |
29
- | [StepperOrientationType](./foundation-forms.stepperorientationtype.md) | |
30
- | [UiSchema](./foundation-forms.uischema.md) | |
31
- | [UiSchemaElement](./foundation-forms.uischemaelement.md) | |
32
- | [UiSchemaElementOptions](./foundation-forms.uischemaelementoptions.md) | |
33
- | [UiSchemaElementType](./foundation-forms.uischemaelementtype.md) | |
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. |
34
42
 
package/docs/api/foundation-forms.standardrendereroptions.md ADDED
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [StandardRendererOptions](./foundation-forms.standardrendereroptions.md)
4
+
5
+ ## StandardRendererOptions type
6
+
7
+ Standard configuration options available for all renderers.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type StandardRendererOptions = {
13
+ hidden?: boolean;
14
+ validateFn?: (data: any, path: string, label: string) => ErrorObject[];
15
+ i18n?: {
16
+ [key: string]: any;
17
+ };
18
+ };
19
+ ```
package/docs/api/foundation-forms.stepperorientationoptions.md ADDED
@@ -0,0 +1,17 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [StepperOrientationOptions](./foundation-forms.stepperorientationoptions.md)
4
+
5
+ ## StepperOrientationOptions type
6
+
7
+ Orientation options available for stepper renderer.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type StepperOrientationOptions = {
13
+ orientation?: StepperOrientationType;
14
+ };
15
+ ```
16
+ **References:** [StepperOrientationType](./foundation-forms.stepperorientationtype.md)
17
+
package/docs/api/foundation-forms.stepperorientationtype.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  ## StepperOrientationType type
6
6
 
7
+ Available orientation for stepper renderer.
7
8
 
8
9
  **Signature:**
9
10
 
package/docs/api/foundation-forms.stepperrendereroptions.md ADDED
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [StepperRendererOptions](./foundation-forms.stepperrendereroptions.md)
4
+
5
+ ## StepperRendererOptions type
6
+
7
+ Configuration options available for stepper renderer.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type StepperRendererOptions = CategorizationRendererOptions;
13
+ ```
14
+ **References:** [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
15
+
package/docs/api/foundation-forms.stringrendereroptions.md ADDED
@@ -0,0 +1,16 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-forms](./foundation-forms.md) &gt; [StringRendererOptions](./foundation-forms.stringrendereroptions.md)
4
+
5
+ ## StringRendererOptions type
6
+
7
+ Configuration options available for string renderer.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type StringRendererOptions = {
13
+ isPassword?: boolean;
14
+ textarea?: boolean;
15
+ };
16
+ ```
package/docs/api/foundation-forms.uischema.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  ## UiSchema type
6
6
 
7
+ 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.
7
8
 
8
9
  **Signature:**
9
10
 
@@ -12,8 +13,8 @@ export type UiSchema = {
12
13
  type: UiSchemaElementType;
13
14
  elements: UiSchemaElement[];
14
15
  dsPrefix?: string;
15
- options?: UiSchemaElementOptions;
16
+ options?: StepperOrientationOptions;
16
17
  };
17
18
  ```
18
- **References:** [UiSchemaElementType](./foundation-forms.uischemaelementtype.md)<!-- -->, [UiSchemaElement](./foundation-forms.uischemaelement.md)<!-- -->, [UiSchemaElementOptions](./foundation-forms.uischemaelementoptions.md)
19
+ **References:** [UiSchemaElementType](./foundation-forms.uischemaelementtype.md)<!-- -->, [UiSchemaElement](./foundation-forms.uischemaelement.md)<!-- -->, [StepperOrientationOptions](./foundation-forms.stepperorientationoptions.md)
19
20
 
package/docs/api/foundation-forms.uischemaelement.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  ## UiSchemaElement type
6
6
 
7
+ A UiSchemaElement that displays property values in a user interface element.
7
8
 
8
9
  **Signature:**
9
10
 
package/docs/api/foundation-forms.uischemaelementoptions.md CHANGED
@@ -4,28 +4,12 @@
4
4
 
5
5
  ## UiSchemaElementOptions type
6
6
 
7
+ All configuration options that are available.
7
8
 
8
9
  **Signature:**
9
10
 
10
11
  ```typescript
11
- export type UiSchemaElementOptions = {
12
- async?: boolean;
13
- orientation?: StepperOrientationType;
14
- allOptionsResourceName?: string;
15
- datasourceConfig?: DatasourceOptions;
16
- hidden?: boolean;
17
- isPassword?: boolean;
18
- validateFn?: (data: any, path: string, label: string) => ErrorObject[];
19
- valueField?: string;
20
- labelField?: string;
21
- textarea?: boolean;
22
- data?: any[];
23
- childUiSchema?: UiSchema;
24
- childElements?: UiSchema[];
25
- i18n?: {
26
- [key: string]: any;
27
- };
28
- };
12
+ export type UiSchemaElementOptions = ConnectedRenderersOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
29
13
  ```
30
- **References:** [StepperOrientationType](./foundation-forms.stepperorientationtype.md)<!-- -->, [UiSchema](./foundation-forms.uischema.md)
14
+ **References:** [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md)<!-- -->, [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md)<!-- -->, [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)<!-- -->, [GroupRendererOptions](./foundation-forms.grouprendereroptions.md)<!-- -->, [StepperRendererOptions](./foundation-forms.stepperrendereroptions.md)<!-- -->, [StringRendererOptions](./foundation-forms.stringrendereroptions.md)<!-- -->, [StandardRendererOptions](./foundation-forms.standardrendereroptions.md)
31
15
 
package/docs/api/foundation-forms.uischemaelementtype.md CHANGED
@@ -4,9 +4,10 @@
4
4
 
5
5
  ## UiSchemaElementType type
6
6
 
7
+ The layouts and control types, which allow you to customize the arrangement of forms.
7
8
 
8
9
  **Signature:**
9
10
 
10
11
  ```typescript
11
- export type UiSchemaElementType = 'Control' | 'VerticalLayout' | any;
12
+ export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
12
13
  ```
package/docs/api-report.md CHANGED
@@ -20,6 +20,26 @@ import { StatePropsOfControl } from '@jsonforms/core';
20
20
  import { UISchemaElement } from '@jsonforms/core';
21
21
  import { ViewTemplate } from '@microsoft/fast-element';
22
22
 
23
+ // @public
24
+ export type ArrayRendererOptions = {
25
+ childUiSchema?: UiSchema;
26
+ };
27
+
28
+ // @public
29
+ export type CategorizationRendererOptions = {
30
+ childElements?: UiSchema[];
31
+ };
32
+
33
+ // @public
34
+ export type ConnectedRenderersOptions = {
35
+ async?: boolean;
36
+ allOptionsResourceName?: string;
37
+ datasourceConfig?: DatasourceOptions;
38
+ valueField?: string;
39
+ labelField?: string;
40
+ data?: any[];
41
+ };
42
+
23
43
  // Warning: (ae-forgotten-export) The symbol "Expressions" needs to be exported by the entry point index.d.ts
24
44
  //
25
45
  // @public
@@ -106,6 +126,9 @@ export const foundationFormTemplate: ViewTemplate<Form, any>;
106
126
  // @public (undocumented)
107
127
  export const genesisErrorTranslator: ErrorTranslator;
108
128
 
129
+ // @public
130
+ export type GroupRendererOptions = CategorizationRendererOptions;
131
+
109
132
  // Warning: (ae-internal-missing-underscore) The name "logger" should be prefixed with an underscore because the declaration is marked as @internal
110
133
  //
111
134
  // @internal (undocumented)
@@ -130,18 +153,41 @@ export type RendererEntry = {
130
153
  // @public (undocumented)
131
154
  export const renderers: any[];
132
155
 
133
- // @public (undocumented)
156
+ // @public
157
+ export type StandardRendererOptions = {
158
+ hidden?: boolean;
159
+ validateFn?: (data: any, path: string, label: string) => ErrorObject[];
160
+ i18n?: {
161
+ [key: string]: any;
162
+ };
163
+ };
164
+
165
+ // @public
166
+ export type StepperOrientationOptions = {
167
+ orientation?: StepperOrientationType;
168
+ };
169
+
170
+ // @public
134
171
  export type StepperOrientationType = 'vertical' | 'horizontal';
135
172
 
136
- // @public (undocumented)
173
+ // @public
174
+ export type StepperRendererOptions = CategorizationRendererOptions;
175
+
176
+ // @public
177
+ export type StringRendererOptions = {
178
+ isPassword?: boolean;
179
+ textarea?: boolean;
180
+ };
181
+
182
+ // @public
137
183
  export type UiSchema = {
138
184
  type: UiSchemaElementType;
139
185
  elements: UiSchemaElement[];
140
186
  dsPrefix?: string;
141
- options?: UiSchemaElementOptions;
187
+ options?: StepperOrientationOptions;
142
188
  };
143
189
 
144
- // @public (undocumented)
190
+ // @public
145
191
  export type UiSchemaElement = {
146
192
  type: UiSchemaElementType;
147
193
  scope: string;
@@ -150,32 +196,15 @@ export type UiSchemaElement = {
150
196
  options?: UiSchemaElementOptions;
151
197
  };
152
198
 
153
- // @public (undocumented)
154
- export type UiSchemaElementOptions = {
155
- async?: boolean;
156
- orientation?: StepperOrientationType;
157
- allOptionsResourceName?: string;
158
- datasourceConfig?: DatasourceOptions;
159
- hidden?: boolean;
160
- isPassword?: boolean;
161
- validateFn?: (data: any, path: string, label: string) => ErrorObject[];
162
- valueField?: string;
163
- labelField?: string;
164
- textarea?: boolean;
165
- data?: any[];
166
- childUiSchema?: UiSchema;
167
- childElements?: UiSchema[];
168
- i18n?: {
169
- [key: string]: any;
170
- };
171
- };
199
+ // @public
200
+ export type UiSchemaElementOptions = ConnectedRenderersOptions | ArrayRendererOptions | CategorizationRendererOptions | GroupRendererOptions | StepperRendererOptions | StringRendererOptions | StandardRendererOptions;
172
201
 
173
- // @public (undocumented)
174
- export type UiSchemaElementType = 'Control' | 'VerticalLayout' | any;
202
+ // @public
203
+ export type UiSchemaElementType = 'Control' | 'VerticalLayout' | 'LayoutVertical2Columns' | 'Categorization' | 'Group' | 'Stepper' | 'HorizontalLayout';
175
204
 
176
205
  // Warnings were encountered during analysis:
177
206
  //
178
- // src/types.ts:57:3 - (ae-forgotten-export) The symbol "DispatchRenderer" needs to be exported by the entry point index.d.ts
207
+ // src/types.ts:231:3 - (ae-forgotten-export) The symbol "DispatchRenderer" needs to be exported by the entry point index.d.ts
179
208
 
180
209
  // (No @packageDocumentation comment for this package)
181
210
 
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.116.0",
4
+ "version": "14.117.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -40,17 +40,17 @@
40
40
  "test:debug": "genx test --debug"
41
41
  },
42
42
  "devDependencies": {
43
- "@genesislcap/foundation-testing": "14.116.0",
44
- "@genesislcap/genx": "14.116.0",
43
+ "@genesislcap/foundation-testing": "14.117.0",
44
+ "@genesislcap/genx": "14.117.0",
45
45
  "@types/json-schema": "^7.0.11",
46
46
  "rimraf": "^3.0.2"
47
47
  },
48
48
  "dependencies": {
49
- "@genesislcap/foundation-comms": "14.116.0",
50
- "@genesislcap/foundation-criteria": "14.116.0",
51
- "@genesislcap/foundation-logger": "14.116.0",
52
- "@genesislcap/foundation-ui": "14.116.0",
53
- "@genesislcap/foundation-utils": "14.116.0",
49
+ "@genesislcap/foundation-comms": "14.117.0",
50
+ "@genesislcap/foundation-criteria": "14.117.0",
51
+ "@genesislcap/foundation-logger": "14.117.0",
52
+ "@genesislcap/foundation-ui": "14.117.0",
53
+ "@genesislcap/foundation-utils": "14.117.0",
54
54
  "@jsonforms/core": "^3.0.0",
55
55
  "@microsoft/fast-components": "^2.21.3",
56
56
  "@microsoft/fast-element": "^1.7.0",
@@ -70,5 +70,5 @@
70
70
  "access": "public"
71
71
  },
72
72
  "customElements": "dist/custom-elements.json",
73
- "gitHead": "803b6e761187833fdeb1c1c8ee1c736c5b273ad9"
73
+ "gitHead": "450cf89ee7d7b6a97f1ce8f8a34d6dcede30bc9e"
74
74
  }