@genesislcap/foundation-forms 14.12.1-web-types.1 → 14.12.2-alpha-8f5bf34.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.
- package/dist/dts/filters/filters.d.ts +0 -6
- package/dist/dts/filters/filters.d.ts.map +1 -1
- package/dist/dts/form.d.ts +1 -9
- package/dist/dts/form.d.ts.map +1 -1
- package/dist/dts/tsdoc-metadata.json +11 -0
- package/dist/esm/filters/filters.js +0 -2
- package/dist/esm/form.js +0 -3
- package/dist/foundation-forms.api.json +1099 -0
- package/dist/foundation-forms.d.ts +298 -0
- package/docs/api-report.md +6 -1
- package/package.json +8 -20
- package/vscode.html-custom-data.json +0 -68
- package/web-types.json +0 -193
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
import { DatasourceOptions } from '@genesislcap/foundation-comms';
|
|
2
|
+
import { ErrorObject } from 'ajv';
|
|
3
|
+
import { ErrorTranslator } from '@jsonforms/core';
|
|
4
|
+
import { Expression } from '@genesislcap/foundation-criteria';
|
|
5
|
+
import { FASTElement } from '@microsoft/fast-element';
|
|
6
|
+
import { FoundationElement } from '@microsoft/fast-foundation';
|
|
7
|
+
import { JsonFormsState } from '@jsonforms/core';
|
|
8
|
+
import { JSONSchema7 } from 'json-schema';
|
|
9
|
+
import { Logger } from '@genesislcap/foundation-utils';
|
|
10
|
+
import { OwnPropsOfControl } from '@jsonforms/core';
|
|
11
|
+
import { RankedTester } from '@jsonforms/core';
|
|
12
|
+
import { StatePropsOfControl } from '@jsonforms/core';
|
|
13
|
+
import { UISchemaElement } from '@jsonforms/core';
|
|
14
|
+
import { ViewTemplate } from '@microsoft/fast-element';
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Creates a expressions/criteria from given payload
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export declare const createExpressions: (payload: any) => Expressions;
|
|
21
|
+
|
|
22
|
+
declare class DispatchRenderer extends FASTElement {
|
|
23
|
+
jsonforms: any;
|
|
24
|
+
jsonformsChanged(): void;
|
|
25
|
+
props: any;
|
|
26
|
+
propsChanged(): void;
|
|
27
|
+
touched: any;
|
|
28
|
+
submitted: boolean;
|
|
29
|
+
submittedChanged(): void;
|
|
30
|
+
dispatch: any;
|
|
31
|
+
control: any;
|
|
32
|
+
renderer: any;
|
|
33
|
+
createRenderer: () => void;
|
|
34
|
+
onBlur(): void;
|
|
35
|
+
get determinedRenderer(): unknown;
|
|
36
|
+
disconnectedCallback(): void;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
declare type Expressions = {
|
|
40
|
+
options: Expression[];
|
|
41
|
+
numberOptions: Expression[];
|
|
42
|
+
dateOptions: Expression[];
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Foundation filters component for automatically generated filters based on json schema
|
|
47
|
+
* obtained from the api, supplied initial data or supplied JSON schema.
|
|
48
|
+
* Allowing customisable filters elements using UI schema and set of custom renderers
|
|
49
|
+
* @beta
|
|
50
|
+
*/
|
|
51
|
+
export declare class Filters extends FoundationElement {
|
|
52
|
+
/**
|
|
53
|
+
* Name of the backend resource which will provide metadata
|
|
54
|
+
* used to generate filters
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
resourceName: string;
|
|
58
|
+
private resourceNameChanged;
|
|
59
|
+
clearFiltersData(): void;
|
|
60
|
+
/**
|
|
61
|
+
* UI schema used to define configuration of the layout and elements in the filters
|
|
62
|
+
* Check {@link UiSchemaElement} for possible options
|
|
63
|
+
*
|
|
64
|
+
* @remarks
|
|
65
|
+
* If not provided will be autogenerated based on json schema or initial data
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* Here's a simple example:
|
|
69
|
+
* ```
|
|
70
|
+
* const sampleUISchema = {
|
|
71
|
+
* type: 'VerticalLayout',
|
|
72
|
+
* elements: [
|
|
73
|
+
* {
|
|
74
|
+
* type: 'Control',
|
|
75
|
+
* scope: '#/properties/QUANTITY',
|
|
76
|
+
* label: 'Quantity',
|
|
77
|
+
* },
|
|
78
|
+
* {
|
|
79
|
+
* type: 'Control',
|
|
80
|
+
* scope: '#/properties/INSTRUMENT_ID',
|
|
81
|
+
* options: {
|
|
82
|
+
* allOptionsResourceName: 'INSTRUMENT',
|
|
83
|
+
* valueField: 'INSTRUMENT_ID',
|
|
84
|
+
* labelField: 'INSTRUMENT_ID',
|
|
85
|
+
* },
|
|
86
|
+
* label: 'Instrument',
|
|
87
|
+
* },
|
|
88
|
+
* {
|
|
89
|
+
* type: 'Control',
|
|
90
|
+
* scope: '#/properties/SIDE',
|
|
91
|
+
* label: 'Side',
|
|
92
|
+
* },
|
|
93
|
+
* ],
|
|
94
|
+
* };
|
|
95
|
+
* ```
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
uischema: UISchemaElement;
|
|
99
|
+
/**
|
|
100
|
+
* Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
renderers: RendererEntry[];
|
|
104
|
+
/**
|
|
105
|
+
* Alternatively to providing {@link Form.resourceName} you can hardcode the JSON schema on the client.
|
|
106
|
+
* @public
|
|
107
|
+
* @remarks
|
|
108
|
+
* Use this when you want to avoid fetching metadata from the server but
|
|
109
|
+
* be aware that it could get out of sync if metadata changes on the server
|
|
110
|
+
*/
|
|
111
|
+
jsonSchema: JSONSchema7;
|
|
112
|
+
private connect;
|
|
113
|
+
/**
|
|
114
|
+
* Initial data for the filters
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
data: any;
|
|
118
|
+
/**
|
|
119
|
+
* Created criteria based on the given data that can be used to filter the data
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
value: string;
|
|
123
|
+
valueChanged(): void;
|
|
124
|
+
/**
|
|
125
|
+
* @internal
|
|
126
|
+
*/
|
|
127
|
+
searchFilters(): void;
|
|
128
|
+
/**
|
|
129
|
+
* @internal
|
|
130
|
+
*/
|
|
131
|
+
onChange(event: CustomEvent): void;
|
|
132
|
+
disconnectedCallback(): void;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/** @internal */
|
|
136
|
+
export declare const filtersLogger: Logger;
|
|
137
|
+
|
|
138
|
+
/** @public */
|
|
139
|
+
export declare const filtersRenderers: any[];
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Foundation form component for automatically generated forms based on json schema
|
|
143
|
+
* obtained from the api, supplied initial data or supplied JSON schema.
|
|
144
|
+
* Allowing customisable form elements using UI schema and set of custom renderers
|
|
145
|
+
* @beta
|
|
146
|
+
*/
|
|
147
|
+
export declare class Form extends FoundationElement {
|
|
148
|
+
/**
|
|
149
|
+
* Name of the backend resource which will provide metadata
|
|
150
|
+
* used to generate form and later used for submitting data
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
resourceName: string;
|
|
154
|
+
private resourceNameChanged;
|
|
155
|
+
private removeDataProperties;
|
|
156
|
+
/**
|
|
157
|
+
* UI schema used to define configuration of the layout and elements in the form
|
|
158
|
+
* Check {@link UiSchemaElement} for possible options
|
|
159
|
+
*
|
|
160
|
+
* @remarks
|
|
161
|
+
* If not provided will be autogenerated based on json schema or initial data
|
|
162
|
+
*
|
|
163
|
+
* @example
|
|
164
|
+
* Here's a simple example:
|
|
165
|
+
* ```
|
|
166
|
+
* const sampleUISchema = {
|
|
167
|
+
* type: 'VerticalLayout',
|
|
168
|
+
* elements: [
|
|
169
|
+
* {
|
|
170
|
+
* type: 'Control',
|
|
171
|
+
* scope: '#/properties/QUANTITY',
|
|
172
|
+
* label: 'Quantity',
|
|
173
|
+
* },
|
|
174
|
+
* {
|
|
175
|
+
* type: 'Control',
|
|
176
|
+
* scope: '#/properties/INSTRUMENT_ID',
|
|
177
|
+
* options: {
|
|
178
|
+
* allOptionsResourceName: 'INSTRUMENT',
|
|
179
|
+
* valueField: 'INSTRUMENT_ID',
|
|
180
|
+
* labelField: 'INSTRUMENT_ID',
|
|
181
|
+
* },
|
|
182
|
+
* label: 'Instrument',
|
|
183
|
+
* },
|
|
184
|
+
* {
|
|
185
|
+
* type: 'Control',
|
|
186
|
+
* scope: '#/properties/SIDE',
|
|
187
|
+
* label: 'Side',
|
|
188
|
+
* },
|
|
189
|
+
* ],
|
|
190
|
+
* };
|
|
191
|
+
* ```
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
uischema: UISchemaElement;
|
|
195
|
+
/**
|
|
196
|
+
* Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
renderers: RendererEntry[];
|
|
200
|
+
/**
|
|
201
|
+
* Alternatively to providing {@link Form.resourceName} you can hardcode the JSON schema on the client.
|
|
202
|
+
* @public
|
|
203
|
+
* @remarks
|
|
204
|
+
* Use this when you want to avoid fetching metadata from the server but
|
|
205
|
+
* be aware that it could get out of sync if metadata changes on the server
|
|
206
|
+
*/
|
|
207
|
+
jsonSchema: JSONSchema7;
|
|
208
|
+
private errors;
|
|
209
|
+
private connect;
|
|
210
|
+
/**
|
|
211
|
+
* Initial data for the form
|
|
212
|
+
* @public
|
|
213
|
+
*/
|
|
214
|
+
data: any;
|
|
215
|
+
/**
|
|
216
|
+
* @internal
|
|
217
|
+
*/
|
|
218
|
+
submitting: boolean;
|
|
219
|
+
/**
|
|
220
|
+
* @internal
|
|
221
|
+
*/
|
|
222
|
+
submitted: boolean;
|
|
223
|
+
readonly: boolean;
|
|
224
|
+
/**
|
|
225
|
+
* @internal
|
|
226
|
+
*/
|
|
227
|
+
_submit(): Promise<void>;
|
|
228
|
+
/**
|
|
229
|
+
* @internal
|
|
230
|
+
*/
|
|
231
|
+
onChange(event: CustomEvent): void;
|
|
232
|
+
disconnectedCallback(): void;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
/** @public */
|
|
236
|
+
export declare const genesisErrorTranslator: ErrorTranslator;
|
|
237
|
+
|
|
238
|
+
/** @internal */
|
|
239
|
+
export declare const logger: Logger;
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Ensures the value of the current field (the one the validator is on) matches the one of the target field.
|
|
243
|
+
* @param target - any other field
|
|
244
|
+
* @returns a validator function that will be run by the smart form during the client-side validation stage
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
export declare const mustMatch: (target: string) => (data: any, path: any, label: any) => {
|
|
248
|
+
instancePath: string;
|
|
249
|
+
message: string;
|
|
250
|
+
schemaPath: string;
|
|
251
|
+
keyword: string;
|
|
252
|
+
params: {};
|
|
253
|
+
}[];
|
|
254
|
+
|
|
255
|
+
/** @public */
|
|
256
|
+
export declare type RendererEntry = {
|
|
257
|
+
renderer: ViewTemplate<DispatchRenderer, any>;
|
|
258
|
+
tester: RankedTester;
|
|
259
|
+
mapper: (state: JsonFormsState, ownProps: OwnPropsOfControl) => StatePropsOfControl;
|
|
260
|
+
};
|
|
261
|
+
|
|
262
|
+
/** @public */
|
|
263
|
+
export declare const renderers: any[];
|
|
264
|
+
|
|
265
|
+
/** @public */
|
|
266
|
+
export declare type UiSchema = {
|
|
267
|
+
type: UiSchemaElementType;
|
|
268
|
+
elements: UiSchemaElement[];
|
|
269
|
+
};
|
|
270
|
+
|
|
271
|
+
/** @public */
|
|
272
|
+
export declare type UiSchemaElement = {
|
|
273
|
+
type: UiSchemaElementType;
|
|
274
|
+
scope: string;
|
|
275
|
+
label?: string;
|
|
276
|
+
options?: UiSchemaElementOptions;
|
|
277
|
+
};
|
|
278
|
+
|
|
279
|
+
/** @public */
|
|
280
|
+
export declare type UiSchemaElementOptions = {
|
|
281
|
+
allOptionsResourceName?: string;
|
|
282
|
+
datasourceConfig?: DatasourceOptions;
|
|
283
|
+
hidden?: boolean;
|
|
284
|
+
isPassword?: boolean;
|
|
285
|
+
validateFn?: (data: any, path: string, label: string) => ErrorObject[];
|
|
286
|
+
valueField?: string;
|
|
287
|
+
labelField?: string;
|
|
288
|
+
textarea?: boolean;
|
|
289
|
+
data?: any[];
|
|
290
|
+
i18n?: {
|
|
291
|
+
[key: string]: any;
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
|
|
295
|
+
/** @public */
|
|
296
|
+
export declare type UiSchemaElementType = 'Control' | 'VerticalLayout' | any;
|
|
297
|
+
|
|
298
|
+
export { }
|
package/docs/api-report.md
CHANGED
|
@@ -58,17 +58,21 @@ export const filtersLogger: Logger;
|
|
|
58
58
|
// @public (undocumented)
|
|
59
59
|
export const filtersRenderers: any[];
|
|
60
60
|
|
|
61
|
-
// @
|
|
61
|
+
// @beta
|
|
62
62
|
export class Form extends FoundationElement {
|
|
63
|
+
// @public
|
|
63
64
|
data: any;
|
|
64
65
|
// (undocumented)
|
|
65
66
|
disconnectedCallback(): void;
|
|
67
|
+
// @public
|
|
66
68
|
jsonSchema: JSONSchema7;
|
|
67
69
|
// @internal (undocumented)
|
|
68
70
|
onChange(event: CustomEvent): void;
|
|
69
71
|
// (undocumented)
|
|
70
72
|
readonly: boolean;
|
|
73
|
+
// @public
|
|
71
74
|
renderers: RendererEntry[];
|
|
75
|
+
// @public
|
|
72
76
|
resourceName: string;
|
|
73
77
|
// @internal (undocumented)
|
|
74
78
|
_submit(): Promise<void>;
|
|
@@ -76,6 +80,7 @@ export class Form extends FoundationElement {
|
|
|
76
80
|
submitted: boolean;
|
|
77
81
|
// @internal (undocumented)
|
|
78
82
|
submitting: boolean;
|
|
83
|
+
// @public
|
|
79
84
|
uischema: UISchemaElement;
|
|
80
85
|
}
|
|
81
86
|
|
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.12.
|
|
4
|
+
"version": "14.12.2-alpha-8f5bf34.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -9,12 +9,6 @@
|
|
|
9
9
|
"engines": {
|
|
10
10
|
"node": ">=16.0.0"
|
|
11
11
|
},
|
|
12
|
-
"wca": {
|
|
13
|
-
"webtypesConfig": {
|
|
14
|
-
"default-icon": "<svg width='26' height='26' viewBox='0 0 26 26' fill='none' xmlns='http://www.w3.org/2000/svg'><path d='M18.7702 23.0437C18.7702 22.4675 18.8526 21.8089 19.0995 21.3149C19.3465 20.7386 19.6758 20.2447 20.0874 19.833C20.4991 19.4214 20.993 19.0921 21.5693 18.8451C22.1456 18.5982 22.7219 18.5158 23.2981 18.5158H25.9326V11.6828H19.1819V14.3172C19.1819 15.5521 18.6879 16.7047 17.8647 17.5279C17.0414 18.3512 15.8888 18.8451 14.7363 18.9275H6.7507V6.99025H16.4651V0.157227H3.54C2.63442 0.157227 1.72884 0.568855 1.07023 1.22746C0.411628 1.88606 0 2.79165 0 3.77955V22.2205C0 23.1261 0.411628 24.0316 1.07023 24.7726C1.72884 25.4312 2.63442 25.8428 3.54 25.8428H18.7702V23.0437Z' fill='white'/></svg>",
|
|
15
|
-
"description-markup": "markdown"
|
|
16
|
-
}
|
|
17
|
-
},
|
|
18
12
|
"exports": {
|
|
19
13
|
".": {
|
|
20
14
|
"types": "./dist/dts/index.d.ts",
|
|
@@ -25,12 +19,11 @@
|
|
|
25
19
|
"config": {
|
|
26
20
|
"PORT": 3090
|
|
27
21
|
},
|
|
28
|
-
"web-types": "./web-types.json",
|
|
29
22
|
"scripts": {
|
|
30
23
|
"api": "npm run api:extract && npm run api:document",
|
|
31
24
|
"api:extract": "api-extractor run",
|
|
32
25
|
"api:document": "api-documenter markdown -i dist -o docs/api",
|
|
33
|
-
"build": "npm run clean && npm run build:tsc",
|
|
26
|
+
"build": "npm run clean && npm run build:tsc && npm run api",
|
|
34
27
|
"build:rollup": "rollup -c",
|
|
35
28
|
"build:rollup:stats": "cross-env ANALYZE=1 npm run build:rollup",
|
|
36
29
|
"build:tsc": "tsc -b ./tsconfig.json",
|
|
@@ -52,14 +45,10 @@
|
|
|
52
45
|
"test:unit:browser:watch": "npm run test:unit:browser -- -w -d",
|
|
53
46
|
"test:unit:node": "npm run test:unit:node:src",
|
|
54
47
|
"test:unit:node:src": "uvu -r tsm -r esm -r ./jsdom.setup.ts ./src \".*.test.ts\"",
|
|
55
|
-
"test:unit:watch": "watchlist src test -- npm run test:unit"
|
|
56
|
-
"modify-json": "node ../../../build/web-types-cleaner.js web-types.json",
|
|
57
|
-
"web-types:analyze": "wca-webtypes analyze src --format webtypes --outFile web-types.json",
|
|
58
|
-
"custom-data:analyze": "wca-webtypes analyze src --format vscode --outFile vscode.html-custom-data.json",
|
|
59
|
-
"all:analyze": "npm run web-types:analyze && npm run custom-data:analyze && npm run modify-json"
|
|
48
|
+
"test:unit:watch": "watchlist src test -- npm run test:unit"
|
|
60
49
|
},
|
|
61
50
|
"devDependencies": {
|
|
62
|
-
"@genesislcap/foundation-testing": "14.12.
|
|
51
|
+
"@genesislcap/foundation-testing": "14.12.2-alpha-8f5bf34.0",
|
|
63
52
|
"@microsoft/api-documenter": "^7.19.13",
|
|
64
53
|
"@microsoft/api-extractor": "^7.31.1",
|
|
65
54
|
"@module-federation/dashboard-plugin": "2.3.0",
|
|
@@ -103,7 +92,6 @@
|
|
|
103
92
|
"typescript": "^4.5.5",
|
|
104
93
|
"uvu": "0.5.4",
|
|
105
94
|
"watchlist": "^0.3.1",
|
|
106
|
-
"web-component-analyzer-webtypes": "2.0.10",
|
|
107
95
|
"webpack": "^5.45.1",
|
|
108
96
|
"webpack-bundle-analyzer": "^4.5.0",
|
|
109
97
|
"webpack-cli": "^4.5.0",
|
|
@@ -111,9 +99,9 @@
|
|
|
111
99
|
"webpack-merge": "^5.7.3"
|
|
112
100
|
},
|
|
113
101
|
"dependencies": {
|
|
114
|
-
"@genesislcap/foundation-comms": "14.12.
|
|
115
|
-
"@genesislcap/foundation-criteria": "14.12.
|
|
116
|
-
"@genesislcap/foundation-utils": "14.12.
|
|
102
|
+
"@genesislcap/foundation-comms": "14.12.2-alpha-8f5bf34.0",
|
|
103
|
+
"@genesislcap/foundation-criteria": "14.12.2-alpha-8f5bf34.0",
|
|
104
|
+
"@genesislcap/foundation-utils": "14.12.2-alpha-8f5bf34.0",
|
|
117
105
|
"@jsonforms/core": "^3.0.0",
|
|
118
106
|
"@microsoft/fast-components": "^2.21.3",
|
|
119
107
|
"@microsoft/fast-element": "^1.7.0",
|
|
@@ -133,5 +121,5 @@
|
|
|
133
121
|
"publishConfig": {
|
|
134
122
|
"access": "public"
|
|
135
123
|
},
|
|
136
|
-
"gitHead": "
|
|
124
|
+
"gitHead": "5eb79664c8e53af316db564dcfa2adb897f49545"
|
|
137
125
|
}
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 1,
|
|
3
|
-
"tags": [
|
|
4
|
-
{
|
|
5
|
-
"name": "foundation-filters",
|
|
6
|
-
"description": "Foundation filters component for automatically generated filters based on json schema\nobtained from the api, supplied initial data or supplied JSON schema.\nAllowing customisable filters elements using UI schema and set of custom renderers\n\nEvents:\n\n * `change` {`Event`} - \n\nAttributes:\n\n * `resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate filters\n\n * `:uischema` {`UISchemaElement`} - [object Object],[object Object],[object Object]\n\n * `:renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs\n\n * `:jsonschema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\n * `:value` {`string`} - Created criteria based on the given data that can be used to filter the data\n\nProperties:\n\n * `resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate filters\n\n * `uischema` {`UISchemaElement`} - [object Object],[object Object],[object Object]\n\n * `renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs\n\n * `jsonSchema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\n * `connect` {`Connect`} - \n\n * `data` - Initial data for the filters\n\n * `value` {`string`} - Created criteria based on the given data that can be used to filter the data\n\n * `_presentation` - \n\n * `$presentation` {`ComponentPresentation | null`} - A property which resolves the ComponentPresentation instance\r\nfor the current component.\n\n * `template` {`void | ElementViewTemplate | null`} - Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.\n\n * `styles` - Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.\n\n * `$fastController` - The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
|
|
7
|
-
"attributes": [
|
|
8
|
-
{
|
|
9
|
-
"name": "resourceName",
|
|
10
|
-
"description": "`resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate filters\n\nProperty: resourceName"
|
|
11
|
-
},
|
|
12
|
-
{
|
|
13
|
-
"name": ":uischema",
|
|
14
|
-
"description": "`:uischema` {`UISchemaElement`} - [object Object],[object Object],[object Object]\n\nProperty: uischema"
|
|
15
|
-
},
|
|
16
|
-
{
|
|
17
|
-
"name": ":renderers",
|
|
18
|
-
"description": "`:renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs\n\nProperty: renderers\n\nDefault: [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]"
|
|
19
|
-
},
|
|
20
|
-
{
|
|
21
|
-
"name": ":jsonschema",
|
|
22
|
-
"description": "`:jsonschema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\nProperty: jsonSchema"
|
|
23
|
-
},
|
|
24
|
-
{
|
|
25
|
-
"name": ":value",
|
|
26
|
-
"description": "`:value` {`string`} - Created criteria based on the given data that can be used to filter the data\n\nProperty: value"
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
"name": "onchange",
|
|
30
|
-
"description": "`change` {`Event`} - "
|
|
31
|
-
}
|
|
32
|
-
]
|
|
33
|
-
},
|
|
34
|
-
{
|
|
35
|
-
"name": "foundation-form",
|
|
36
|
-
"description": "Foundation form component for automatically generated forms based on json schema\nobtained from the api, supplied initial data or supplied JSON schema.\nAllowing customisable form elements using UI schema and set of custom renderers\n\nAttributes:\n\n * `resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate form and later used for submitting data\n\n * `:uischema` {`UISchemaElement`} - UI schema used to define configuration of the layout and elements in the form\n\n * `:renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs\n\n * `:jsonSchema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\n * `:data` - Initial data for the form\n\n * `readonly` {boolean} - \n\nProperties:\n\n * `resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate form and later used for submitting data\n\n * `uischema` {`UISchemaElement`} - UI schema used to define configuration of the layout and elements in the form\n\n * `renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs\n\n * `jsonSchema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\n * `errors` {`ErrorObject<string, Record<string, any>, unknown>[]`} - \n\n * `connect` {`Connect`} - \n\n * `data` - Initial data for the form\n\n * `submitting` {`boolean`} - \n\n * `submitted` {`boolean`} - \n\n * `readonly` {boolean} - \n\n * `_presentation` - \n\n * `$presentation` {`ComponentPresentation | null`} - A property which resolves the ComponentPresentation instance\r\nfor the current component.\n\n * `template` {`void | ElementViewTemplate | null`} - Sets the template of the element instance. When undefined,\r\nthe element will attempt to resolve the template from\r\nthe associated presentation or custom element definition.\n\n * `styles` - Sets the default styles for the element instance. When undefined,\r\nthe element will attempt to resolve default styles from\r\nthe associated presentation or custom element definition.\n\n * `$fastController` - The underlying controller that handles the lifecycle and rendering of\r\nthis FASTElement.",
|
|
37
|
-
"attributes": [
|
|
38
|
-
{
|
|
39
|
-
"name": "resourceName",
|
|
40
|
-
"description": "`resourceName` {`string`} - Name of the backend resource which will provide metadata\nused to generate form and later used for submitting data\n\nProperty: resourceName"
|
|
41
|
-
},
|
|
42
|
-
{
|
|
43
|
-
"name": ":uischema",
|
|
44
|
-
"description": "`:uischema` {`UISchemaElement`} - UI schema used to define configuration of the layout and elements in the form\n\nProperty: uischema"
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"name": ":renderers",
|
|
48
|
-
"description": "`:renderers` {`RendererEntry[]`} - Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs\n\nProperty: renderers\n\nDefault: [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]"
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
"name": ":jsonSchema",
|
|
52
|
-
"description": "`:jsonSchema` {`JSONSchema7`} - [object Object],[object Object],[object Object]\n\nProperty: jsonSchema"
|
|
53
|
-
},
|
|
54
|
-
{
|
|
55
|
-
"name": ":data",
|
|
56
|
-
"description": "`:data` - Initial data for the form\n\nProperty: data\n\nDefault: [object Object]"
|
|
57
|
-
},
|
|
58
|
-
{
|
|
59
|
-
"name": "readonly",
|
|
60
|
-
"description": "`readonly` {boolean} - \n\nProperty: readonly",
|
|
61
|
-
"valueSet": "v"
|
|
62
|
-
}
|
|
63
|
-
]
|
|
64
|
-
}
|
|
65
|
-
],
|
|
66
|
-
"globalAttributes": [],
|
|
67
|
-
"valueSets": []
|
|
68
|
-
}
|
package/web-types.json
DELETED
|
@@ -1,193 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json.schemastore.org/web-types",
|
|
3
|
-
"name": "@genesislcap/foundation-forms",
|
|
4
|
-
"version": "14.12.1",
|
|
5
|
-
"default-icon": "<svg width='26' height='26' viewBox='0 0 26 26' fill='none' xmlns='http://www.w3.org/2000/svg'><path d='M18.7702 23.0437C18.7702 22.4675 18.8526 21.8089 19.0995 21.3149C19.3465 20.7386 19.6758 20.2447 20.0874 19.833C20.4991 19.4214 20.993 19.0921 21.5693 18.8451C22.1456 18.5982 22.7219 18.5158 23.2981 18.5158H25.9326V11.6828H19.1819V14.3172C19.1819 15.5521 18.6879 16.7047 17.8647 17.5279C17.0414 18.3512 15.8888 18.8451 14.7363 18.9275H6.7507V6.99025H16.4651V0.157227H3.54C2.63442 0.157227 1.72884 0.568855 1.07023 1.22746C0.411628 1.88606 0 2.79165 0 3.77955V22.2205C0 23.1261 0.411628 24.0316 1.07023 24.7726C1.72884 25.4312 2.63442 25.8428 3.54 25.8428H18.7702V23.0437Z' fill='white'/></svg>",
|
|
6
|
-
"description-markup": "markdown",
|
|
7
|
-
"contributions": {
|
|
8
|
-
"html": {
|
|
9
|
-
"elements": [
|
|
10
|
-
{
|
|
11
|
-
"name": "foundation-filters",
|
|
12
|
-
"description": "Foundation filters component for automatically generated filters based on json schema\nobtained from the api, supplied initial data or supplied JSON schema.\nAllowing customisable filters elements using UI schema and set of custom renderers",
|
|
13
|
-
"source": {
|
|
14
|
-
"module": "./src/filters/filters.ts",
|
|
15
|
-
"symbol": "Filters"
|
|
16
|
-
},
|
|
17
|
-
"attributes": [
|
|
18
|
-
{
|
|
19
|
-
"name": "resourceName",
|
|
20
|
-
"required": false,
|
|
21
|
-
"priority": "normal",
|
|
22
|
-
"value": {
|
|
23
|
-
"type": "string",
|
|
24
|
-
"required": true
|
|
25
|
-
},
|
|
26
|
-
"description": "Name of the backend resource which will provide metadata\nused to generate filters",
|
|
27
|
-
"source": {
|
|
28
|
-
"module": "./src/filters/filters.ts",
|
|
29
|
-
"symbol": "Filters.resourceName"
|
|
30
|
-
}
|
|
31
|
-
},
|
|
32
|
-
{
|
|
33
|
-
"name": ":uischema",
|
|
34
|
-
"required": false,
|
|
35
|
-
"priority": "normal",
|
|
36
|
-
"value": {
|
|
37
|
-
"type": "UISchemaElement",
|
|
38
|
-
"required": true
|
|
39
|
-
},
|
|
40
|
-
"description": "[object Object],[object Object],[object Object]",
|
|
41
|
-
"source": {
|
|
42
|
-
"module": "./src/filters/filters.ts",
|
|
43
|
-
"symbol": "Filters.uischema"
|
|
44
|
-
}
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"name": ":renderers",
|
|
48
|
-
"required": false,
|
|
49
|
-
"priority": "normal",
|
|
50
|
-
"value": {
|
|
51
|
-
"type": "RendererEntry[]",
|
|
52
|
-
"required": true,
|
|
53
|
-
"default": "[{\"renderer\":\"StringControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"StringControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"BooleanControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"LayoutVertical2ColumnsRendererTemplate\",\"mapper\":\"mapStateToLayoutProps\"},{\"renderer\":\"LayoutRendererTemplate\",\"mapper\":\"mapStateToLayoutProps\"},{\"renderer\":\"FilterNumberControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"ConnectedMultiselectControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"EnumControlRendererTemplate\",\"mapper\":\"mapStateToEnumControlProps\"},{\"renderer\":\"ConnectedSelectControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"DateControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"InvisibleControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"}]"
|
|
54
|
-
},
|
|
55
|
-
"description": "Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs",
|
|
56
|
-
"source": {
|
|
57
|
-
"module": "./src/filters/filters.ts",
|
|
58
|
-
"symbol": "Filters.renderers"
|
|
59
|
-
}
|
|
60
|
-
},
|
|
61
|
-
{
|
|
62
|
-
"name": ":jsonschema",
|
|
63
|
-
"required": false,
|
|
64
|
-
"priority": "normal",
|
|
65
|
-
"value": {
|
|
66
|
-
"type": "JSONSchema7",
|
|
67
|
-
"required": true
|
|
68
|
-
},
|
|
69
|
-
"description": "[object Object],[object Object],[object Object]",
|
|
70
|
-
"source": {
|
|
71
|
-
"module": "./src/filters/filters.ts",
|
|
72
|
-
"symbol": "Filters.jsonSchema"
|
|
73
|
-
}
|
|
74
|
-
},
|
|
75
|
-
{
|
|
76
|
-
"name": ":value",
|
|
77
|
-
"required": false,
|
|
78
|
-
"priority": "normal",
|
|
79
|
-
"value": {
|
|
80
|
-
"type": "string",
|
|
81
|
-
"required": true
|
|
82
|
-
},
|
|
83
|
-
"description": "Created criteria based on the given data that can be used to filter the data",
|
|
84
|
-
"source": {
|
|
85
|
-
"module": "./src/filters/filters.ts",
|
|
86
|
-
"symbol": "Filters.value"
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
]
|
|
90
|
-
},
|
|
91
|
-
{
|
|
92
|
-
"name": "foundation-form",
|
|
93
|
-
"description": "Foundation form component for automatically generated forms based on json schema\nobtained from the api, supplied initial data or supplied JSON schema.\nAllowing customisable form elements using UI schema and set of custom renderers",
|
|
94
|
-
"source": {
|
|
95
|
-
"module": "./src/form.ts",
|
|
96
|
-
"symbol": "Form"
|
|
97
|
-
},
|
|
98
|
-
"attributes": [
|
|
99
|
-
{
|
|
100
|
-
"name": "resourceName",
|
|
101
|
-
"required": false,
|
|
102
|
-
"priority": "normal",
|
|
103
|
-
"value": {
|
|
104
|
-
"type": "string",
|
|
105
|
-
"required": true
|
|
106
|
-
},
|
|
107
|
-
"description": "Name of the backend resource which will provide metadata\nused to generate form and later used for submitting data",
|
|
108
|
-
"source": {
|
|
109
|
-
"module": "./src/form.ts",
|
|
110
|
-
"symbol": "Form.resourceName"
|
|
111
|
-
}
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
"name": ":uischema",
|
|
115
|
-
"required": false,
|
|
116
|
-
"priority": "normal",
|
|
117
|
-
"value": {
|
|
118
|
-
"type": "UISchemaElement",
|
|
119
|
-
"required": true
|
|
120
|
-
},
|
|
121
|
-
"description": "UI schema used to define configuration of the layout and elements in the form",
|
|
122
|
-
"source": {
|
|
123
|
-
"module": "./src/form.ts",
|
|
124
|
-
"symbol": "Form.uischema"
|
|
125
|
-
}
|
|
126
|
-
},
|
|
127
|
-
{
|
|
128
|
-
"name": ":renderers",
|
|
129
|
-
"required": false,
|
|
130
|
-
"priority": "normal",
|
|
131
|
-
"value": {
|
|
132
|
-
"type": "RendererEntry[]",
|
|
133
|
-
"required": true,
|
|
134
|
-
"default": "[{\"renderer\":\"StringControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"StringControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"BooleanControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"LayoutVertical2ColumnsRendererTemplate\",\"mapper\":\"mapStateToLayoutProps\"},{\"renderer\":\"LayoutRendererTemplate\",\"mapper\":\"mapStateToLayoutProps\"},{\"renderer\":\"NumberControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"ConnectedMultiselectControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"EnumControlRendererTemplate\",\"mapper\":\"mapStateToEnumControlProps\"},{\"renderer\":\"ConnectedSelectControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"DateControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"},{\"renderer\":\"InvisibleControlRendererTemplate\",\"mapper\":\"mapStateToControlProps\"}]"
|
|
135
|
-
},
|
|
136
|
-
"description": "Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs",
|
|
137
|
-
"source": {
|
|
138
|
-
"module": "./src/form.ts",
|
|
139
|
-
"symbol": "Form.renderers"
|
|
140
|
-
}
|
|
141
|
-
},
|
|
142
|
-
{
|
|
143
|
-
"name": ":jsonSchema",
|
|
144
|
-
"required": false,
|
|
145
|
-
"priority": "normal",
|
|
146
|
-
"value": {
|
|
147
|
-
"type": "JSONSchema7",
|
|
148
|
-
"required": true
|
|
149
|
-
},
|
|
150
|
-
"description": "[object Object],[object Object],[object Object]",
|
|
151
|
-
"source": {
|
|
152
|
-
"module": "./src/form.ts",
|
|
153
|
-
"symbol": "Form.jsonSchema"
|
|
154
|
-
}
|
|
155
|
-
},
|
|
156
|
-
{
|
|
157
|
-
"name": ":data",
|
|
158
|
-
"required": false,
|
|
159
|
-
"priority": "normal",
|
|
160
|
-
"value": {
|
|
161
|
-
"kind": "plain",
|
|
162
|
-
"type": "",
|
|
163
|
-
"required": true,
|
|
164
|
-
"default": "{}"
|
|
165
|
-
},
|
|
166
|
-
"description": "Initial data for the form",
|
|
167
|
-
"source": {
|
|
168
|
-
"module": "./src/form.ts",
|
|
169
|
-
"symbol": "Form.data"
|
|
170
|
-
}
|
|
171
|
-
},
|
|
172
|
-
{
|
|
173
|
-
"name": "readonly",
|
|
174
|
-
"required": false,
|
|
175
|
-
"priority": "normal",
|
|
176
|
-
"value": {
|
|
177
|
-
"type": "boolean",
|
|
178
|
-
"required": false
|
|
179
|
-
},
|
|
180
|
-
"source": {
|
|
181
|
-
"module": "./src/form.ts",
|
|
182
|
-
"symbol": "Form.readonly"
|
|
183
|
-
}
|
|
184
|
-
}
|
|
185
|
-
]
|
|
186
|
-
}
|
|
187
|
-
]
|
|
188
|
-
},
|
|
189
|
-
"css": {
|
|
190
|
-
"properties": []
|
|
191
|
-
}
|
|
192
|
-
}
|
|
193
|
-
}
|