@genesislcap/foundation-forms 14.12.0 → 14.12.1-web-types.1

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 (13) hide show
  1. package/dist/dts/filters/filters.d.ts +6 -0
  2. package/dist/dts/filters/filters.d.ts.map +1 -1
  3. package/dist/dts/form.d.ts +9 -1
  4. package/dist/dts/form.d.ts.map +1 -1
  5. package/dist/esm/filters/filters.js +2 -0
  6. package/dist/esm/form.js +3 -0
  7. package/docs/api-report.md +1 -6
  8. package/package.json +20 -8
  9. package/vscode.html-custom-data.json +68 -0
  10. package/web-types.json +193 -0
  11. package/dist/dts/tsdoc-metadata.json +0 -11
  12. package/dist/foundation-forms.api.json +0 -1099
  13. package/dist/foundation-forms.d.ts +0 -298
package/dist/foundation-forms.api.json DELETED
@@ -1,1099 +0,0 @@
1
- {
2
- "metadata": {
3
- "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.34.4",
5
- "schemaVersion": 1011,
6
- "oldestForwardsCompatibleVersion": 1001,
7
- "tsdocConfig": {
8
- "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
9
- "noStandardTags": true,
10
- "tagDefinitions": [
11
- {
12
- "tagName": "@alpha",
13
- "syntaxKind": "modifier"
14
- },
15
- {
16
- "tagName": "@beta",
17
- "syntaxKind": "modifier"
18
- },
19
- {
20
- "tagName": "@defaultValue",
21
- "syntaxKind": "block"
22
- },
23
- {
24
- "tagName": "@decorator",
25
- "syntaxKind": "block",
26
- "allowMultiple": true
27
- },
28
- {
29
- "tagName": "@deprecated",
30
- "syntaxKind": "block"
31
- },
32
- {
33
- "tagName": "@eventProperty",
34
- "syntaxKind": "modifier"
35
- },
36
- {
37
- "tagName": "@example",
38
- "syntaxKind": "block",
39
- "allowMultiple": true
40
- },
41
- {
42
- "tagName": "@experimental",
43
- "syntaxKind": "modifier"
44
- },
45
- {
46
- "tagName": "@inheritDoc",
47
- "syntaxKind": "inline"
48
- },
49
- {
50
- "tagName": "@internal",
51
- "syntaxKind": "modifier"
52
- },
53
- {
54
- "tagName": "@label",
55
- "syntaxKind": "inline"
56
- },
57
- {
58
- "tagName": "@link",
59
- "syntaxKind": "inline",
60
- "allowMultiple": true
61
- },
62
- {
63
- "tagName": "@override",
64
- "syntaxKind": "modifier"
65
- },
66
- {
67
- "tagName": "@packageDocumentation",
68
- "syntaxKind": "modifier"
69
- },
70
- {
71
- "tagName": "@param",
72
- "syntaxKind": "block",
73
- "allowMultiple": true
74
- },
75
- {
76
- "tagName": "@privateRemarks",
77
- "syntaxKind": "block"
78
- },
79
- {
80
- "tagName": "@public",
81
- "syntaxKind": "modifier"
82
- },
83
- {
84
- "tagName": "@readonly",
85
- "syntaxKind": "modifier"
86
- },
87
- {
88
- "tagName": "@remarks",
89
- "syntaxKind": "block"
90
- },
91
- {
92
- "tagName": "@returns",
93
- "syntaxKind": "block"
94
- },
95
- {
96
- "tagName": "@sealed",
97
- "syntaxKind": "modifier"
98
- },
99
- {
100
- "tagName": "@see",
101
- "syntaxKind": "block"
102
- },
103
- {
104
- "tagName": "@throws",
105
- "syntaxKind": "block",
106
- "allowMultiple": true
107
- },
108
- {
109
- "tagName": "@typeParam",
110
- "syntaxKind": "block",
111
- "allowMultiple": true
112
- },
113
- {
114
- "tagName": "@virtual",
115
- "syntaxKind": "modifier"
116
- },
117
- {
118
- "tagName": "@betaDocumentation",
119
- "syntaxKind": "modifier"
120
- },
121
- {
122
- "tagName": "@internalRemarks",
123
- "syntaxKind": "block"
124
- },
125
- {
126
- "tagName": "@preapproved",
127
- "syntaxKind": "modifier"
128
- }
129
- ],
130
- "supportForTags": {
131
- "@alpha": true,
132
- "@beta": true,
133
- "@defaultValue": true,
134
- "@decorator": true,
135
- "@deprecated": true,
136
- "@eventProperty": true,
137
- "@example": true,
138
- "@experimental": true,
139
- "@inheritDoc": true,
140
- "@internal": true,
141
- "@label": true,
142
- "@link": true,
143
- "@override": true,
144
- "@packageDocumentation": true,
145
- "@param": true,
146
- "@privateRemarks": true,
147
- "@public": true,
148
- "@readonly": true,
149
- "@remarks": true,
150
- "@returns": true,
151
- "@sealed": true,
152
- "@see": true,
153
- "@throws": true,
154
- "@typeParam": true,
155
- "@virtual": true,
156
- "@betaDocumentation": true,
157
- "@internalRemarks": true,
158
- "@preapproved": true
159
- },
160
- "reportUnsupportedHtmlElements": false
161
- }
162
- },
163
- "kind": "Package",
164
- "canonicalReference": "@genesislcap/foundation-forms!",
165
- "docComment": "",
166
- "name": "@genesislcap/foundation-forms",
167
- "preserveMemberOrder": false,
168
- "members": [
169
- {
170
- "kind": "EntryPoint",
171
- "canonicalReference": "@genesislcap/foundation-forms!",
172
- "name": "",
173
- "preserveMemberOrder": false,
174
- "members": [
175
- {
176
- "kind": "Variable",
177
- "canonicalReference": "@genesislcap/foundation-forms!createExpressions:var",
178
- "docComment": "/**\n * Creates a expressions/criteria from given payload\n *\n * @public\n */\n",
179
- "excerptTokens": [
180
- {
181
- "kind": "Content",
182
- "text": "createExpressions: "
183
- },
184
- {
185
- "kind": "Content",
186
- "text": "(payload: any) => "
187
- },
188
- {
189
- "kind": "Reference",
190
- "text": "Expressions",
191
- "canonicalReference": "@genesislcap/foundation-forms!~Expressions:type"
192
- }
193
- ],
194
- "fileUrlPath": "src/utils/filters.ts",
195
- "isReadonly": true,
196
- "releaseTag": "Public",
197
- "name": "createExpressions",
198
- "variableTypeTokenRange": {
199
- "startIndex": 1,
200
- "endIndex": 3
201
- }
202
- },
203
- {
204
- "kind": "Class",
205
- "canonicalReference": "@genesislcap/foundation-forms!Filters:class",
206
- "docComment": "/**\n * 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\n *\n * @beta\n */\n",
207
- "excerptTokens": [
208
- {
209
- "kind": "Content",
210
- "text": "export declare class Filters extends "
211
- },
212
- {
213
- "kind": "Reference",
214
- "text": "FoundationElement",
215
- "canonicalReference": "@microsoft/fast-foundation!FoundationElement:class"
216
- },
217
- {
218
- "kind": "Content",
219
- "text": " "
220
- }
221
- ],
222
- "fileUrlPath": "src/filters/filters.ts",
223
- "releaseTag": "Beta",
224
- "isAbstract": false,
225
- "name": "Filters",
226
- "preserveMemberOrder": false,
227
- "members": [
228
- {
229
- "kind": "Method",
230
- "canonicalReference": "@genesislcap/foundation-forms!Filters#clearFiltersData:member(1)",
231
- "docComment": "",
232
- "excerptTokens": [
233
- {
234
- "kind": "Content",
235
- "text": "clearFiltersData(): "
236
- },
237
- {
238
- "kind": "Content",
239
- "text": "void"
240
- },
241
- {
242
- "kind": "Content",
243
- "text": ";"
244
- }
245
- ],
246
- "isStatic": false,
247
- "returnTypeTokenRange": {
248
- "startIndex": 1,
249
- "endIndex": 2
250
- },
251
- "releaseTag": "Beta",
252
- "isProtected": false,
253
- "overloadIndex": 1,
254
- "parameters": [],
255
- "isOptional": false,
256
- "isAbstract": false,
257
- "name": "clearFiltersData"
258
- },
259
- {
260
- "kind": "Property",
261
- "canonicalReference": "@genesislcap/foundation-forms!Filters#data:member",
262
- "docComment": "/**\n * Initial data for the filters\n *\n * @public\n */\n",
263
- "excerptTokens": [
264
- {
265
- "kind": "Content",
266
- "text": "data: "
267
- },
268
- {
269
- "kind": "Content",
270
- "text": "any"
271
- },
272
- {
273
- "kind": "Content",
274
- "text": ";"
275
- }
276
- ],
277
- "isReadonly": false,
278
- "isOptional": false,
279
- "releaseTag": "Public",
280
- "name": "data",
281
- "propertyTypeTokenRange": {
282
- "startIndex": 1,
283
- "endIndex": 2
284
- },
285
- "isStatic": false,
286
- "isProtected": false,
287
- "isAbstract": false
288
- },
289
- {
290
- "kind": "Method",
291
- "canonicalReference": "@genesislcap/foundation-forms!Filters#disconnectedCallback:member(1)",
292
- "docComment": "",
293
- "excerptTokens": [
294
- {
295
- "kind": "Content",
296
- "text": "disconnectedCallback(): "
297
- },
298
- {
299
- "kind": "Content",
300
- "text": "void"
301
- },
302
- {
303
- "kind": "Content",
304
- "text": ";"
305
- }
306
- ],
307
- "isStatic": false,
308
- "returnTypeTokenRange": {
309
- "startIndex": 1,
310
- "endIndex": 2
311
- },
312
- "releaseTag": "Beta",
313
- "isProtected": false,
314
- "overloadIndex": 1,
315
- "parameters": [],
316
- "isOptional": false,
317
- "isAbstract": false,
318
- "name": "disconnectedCallback"
319
- },
320
- {
321
- "kind": "Property",
322
- "canonicalReference": "@genesislcap/foundation-forms!Filters#jsonSchema:member",
323
- "docComment": "/**\n * Alternatively to providing {@link Form.resourceName} you can hardcode the JSON schema on the client.\n *\n * @remarks\n *\n * Use this when you want to avoid fetching metadata from the server but be aware that it could get out of sync if metadata changes on the server\n *\n * @public\n */\n",
324
- "excerptTokens": [
325
- {
326
- "kind": "Content",
327
- "text": "jsonSchema: "
328
- },
329
- {
330
- "kind": "Reference",
331
- "text": "JSONSchema7",
332
- "canonicalReference": "@types/json-schema!JSONSchema7:interface"
333
- },
334
- {
335
- "kind": "Content",
336
- "text": ";"
337
- }
338
- ],
339
- "isReadonly": false,
340
- "isOptional": false,
341
- "releaseTag": "Public",
342
- "name": "jsonSchema",
343
- "propertyTypeTokenRange": {
344
- "startIndex": 1,
345
- "endIndex": 2
346
- },
347
- "isStatic": false,
348
- "isProtected": false,
349
- "isAbstract": false
350
- },
351
- {
352
- "kind": "Property",
353
- "canonicalReference": "@genesislcap/foundation-forms!Filters#renderers:member",
354
- "docComment": "/**\n * Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs\n *\n * @public\n */\n",
355
- "excerptTokens": [
356
- {
357
- "kind": "Content",
358
- "text": "renderers: "
359
- },
360
- {
361
- "kind": "Reference",
362
- "text": "RendererEntry",
363
- "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type"
364
- },
365
- {
366
- "kind": "Content",
367
- "text": "[]"
368
- },
369
- {
370
- "kind": "Content",
371
- "text": ";"
372
- }
373
- ],
374
- "isReadonly": false,
375
- "isOptional": false,
376
- "releaseTag": "Public",
377
- "name": "renderers",
378
- "propertyTypeTokenRange": {
379
- "startIndex": 1,
380
- "endIndex": 3
381
- },
382
- "isStatic": false,
383
- "isProtected": false,
384
- "isAbstract": false
385
- },
386
- {
387
- "kind": "Property",
388
- "canonicalReference": "@genesislcap/foundation-forms!Filters#resourceName:member",
389
- "docComment": "/**\n * Name of the backend resource which will provide metadata used to generate filters\n *\n * @public\n */\n",
390
- "excerptTokens": [
391
- {
392
- "kind": "Content",
393
- "text": "resourceName: "
394
- },
395
- {
396
- "kind": "Content",
397
- "text": "string"
398
- },
399
- {
400
- "kind": "Content",
401
- "text": ";"
402
- }
403
- ],
404
- "isReadonly": false,
405
- "isOptional": false,
406
- "releaseTag": "Public",
407
- "name": "resourceName",
408
- "propertyTypeTokenRange": {
409
- "startIndex": 1,
410
- "endIndex": 2
411
- },
412
- "isStatic": false,
413
- "isProtected": false,
414
- "isAbstract": false
415
- },
416
- {
417
- "kind": "Property",
418
- "canonicalReference": "@genesislcap/foundation-forms!Filters#uischema:member",
419
- "docComment": "/**\n * UI schema used to define configuration of the layout and elements in the filters Check {@link UiSchemaElement} for possible options\n *\n * @remarks\n *\n * If not provided will be autogenerated based on json schema or initial data\n *\n * @example\n *\n * Here's a simple example:\n * ```\n * const sampleUISchema = {\n * type: 'VerticalLayout',\n * elements: [\n * {\n * type: 'Control',\n * scope: '#/properties/QUANTITY',\n * label: 'Quantity',\n * },\n * {\n * type: 'Control',\n * scope: '#/properties/INSTRUMENT_ID',\n * options: {\n * allOptionsResourceName: 'INSTRUMENT',\n * valueField: 'INSTRUMENT_ID',\n * labelField: 'INSTRUMENT_ID',\n * },\n * label: 'Instrument',\n * },\n * {\n * type: 'Control',\n * scope: '#/properties/SIDE',\n * label: 'Side',\n * },\n * ],\n * };\n * ```\n *\n * @public\n */\n",
420
- "excerptTokens": [
421
- {
422
- "kind": "Content",
423
- "text": "uischema: "
424
- },
425
- {
426
- "kind": "Reference",
427
- "text": "UISchemaElement",
428
- "canonicalReference": "@jsonforms/core!UISchemaElement:interface"
429
- },
430
- {
431
- "kind": "Content",
432
- "text": ";"
433
- }
434
- ],
435
- "isReadonly": false,
436
- "isOptional": false,
437
- "releaseTag": "Public",
438
- "name": "uischema",
439
- "propertyTypeTokenRange": {
440
- "startIndex": 1,
441
- "endIndex": 2
442
- },
443
- "isStatic": false,
444
- "isProtected": false,
445
- "isAbstract": false
446
- },
447
- {
448
- "kind": "Property",
449
- "canonicalReference": "@genesislcap/foundation-forms!Filters#value:member",
450
- "docComment": "/**\n * Created criteria based on the given data that can be used to filter the data\n *\n * @public\n */\n",
451
- "excerptTokens": [
452
- {
453
- "kind": "Content",
454
- "text": "value: "
455
- },
456
- {
457
- "kind": "Content",
458
- "text": "string"
459
- },
460
- {
461
- "kind": "Content",
462
- "text": ";"
463
- }
464
- ],
465
- "isReadonly": false,
466
- "isOptional": false,
467
- "releaseTag": "Public",
468
- "name": "value",
469
- "propertyTypeTokenRange": {
470
- "startIndex": 1,
471
- "endIndex": 2
472
- },
473
- "isStatic": false,
474
- "isProtected": false,
475
- "isAbstract": false
476
- },
477
- {
478
- "kind": "Method",
479
- "canonicalReference": "@genesislcap/foundation-forms!Filters#valueChanged:member(1)",
480
- "docComment": "",
481
- "excerptTokens": [
482
- {
483
- "kind": "Content",
484
- "text": "valueChanged(): "
485
- },
486
- {
487
- "kind": "Content",
488
- "text": "void"
489
- },
490
- {
491
- "kind": "Content",
492
- "text": ";"
493
- }
494
- ],
495
- "isStatic": false,
496
- "returnTypeTokenRange": {
497
- "startIndex": 1,
498
- "endIndex": 2
499
- },
500
- "releaseTag": "Beta",
501
- "isProtected": false,
502
- "overloadIndex": 1,
503
- "parameters": [],
504
- "isOptional": false,
505
- "isAbstract": false,
506
- "name": "valueChanged"
507
- }
508
- ],
509
- "extendsTokenRange": {
510
- "startIndex": 1,
511
- "endIndex": 2
512
- },
513
- "implementsTokenRanges": []
514
- },
515
- {
516
- "kind": "Variable",
517
- "canonicalReference": "@genesislcap/foundation-forms!filtersRenderers:var",
518
- "docComment": "/**\n * @public\n */\n",
519
- "excerptTokens": [
520
- {
521
- "kind": "Content",
522
- "text": "filtersRenderers: "
523
- },
524
- {
525
- "kind": "Content",
526
- "text": "any[]"
527
- }
528
- ],
529
- "fileUrlPath": "src/filters/filters.ts",
530
- "isReadonly": true,
531
- "releaseTag": "Public",
532
- "name": "filtersRenderers",
533
- "variableTypeTokenRange": {
534
- "startIndex": 1,
535
- "endIndex": 2
536
- }
537
- },
538
- {
539
- "kind": "Class",
540
- "canonicalReference": "@genesislcap/foundation-forms!Form:class",
541
- "docComment": "/**\n * 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\n *\n * @beta\n */\n",
542
- "excerptTokens": [
543
- {
544
- "kind": "Content",
545
- "text": "export declare class Form extends "
546
- },
547
- {
548
- "kind": "Reference",
549
- "text": "FoundationElement",
550
- "canonicalReference": "@microsoft/fast-foundation!FoundationElement:class"
551
- },
552
- {
553
- "kind": "Content",
554
- "text": " "
555
- }
556
- ],
557
- "fileUrlPath": "src/form.ts",
558
- "releaseTag": "Beta",
559
- "isAbstract": false,
560
- "name": "Form",
561
- "preserveMemberOrder": false,
562
- "members": [
563
- {
564
- "kind": "Property",
565
- "canonicalReference": "@genesislcap/foundation-forms!Form#data:member",
566
- "docComment": "/**\n * Initial data for the form\n *\n * @public\n */\n",
567
- "excerptTokens": [
568
- {
569
- "kind": "Content",
570
- "text": "data: "
571
- },
572
- {
573
- "kind": "Content",
574
- "text": "any"
575
- },
576
- {
577
- "kind": "Content",
578
- "text": ";"
579
- }
580
- ],
581
- "isReadonly": false,
582
- "isOptional": false,
583
- "releaseTag": "Public",
584
- "name": "data",
585
- "propertyTypeTokenRange": {
586
- "startIndex": 1,
587
- "endIndex": 2
588
- },
589
- "isStatic": false,
590
- "isProtected": false,
591
- "isAbstract": false
592
- },
593
- {
594
- "kind": "Method",
595
- "canonicalReference": "@genesislcap/foundation-forms!Form#disconnectedCallback:member(1)",
596
- "docComment": "",
597
- "excerptTokens": [
598
- {
599
- "kind": "Content",
600
- "text": "disconnectedCallback(): "
601
- },
602
- {
603
- "kind": "Content",
604
- "text": "void"
605
- },
606
- {
607
- "kind": "Content",
608
- "text": ";"
609
- }
610
- ],
611
- "isStatic": false,
612
- "returnTypeTokenRange": {
613
- "startIndex": 1,
614
- "endIndex": 2
615
- },
616
- "releaseTag": "Beta",
617
- "isProtected": false,
618
- "overloadIndex": 1,
619
- "parameters": [],
620
- "isOptional": false,
621
- "isAbstract": false,
622
- "name": "disconnectedCallback"
623
- },
624
- {
625
- "kind": "Property",
626
- "canonicalReference": "@genesislcap/foundation-forms!Form#jsonSchema:member",
627
- "docComment": "/**\n * Alternatively to providing {@link Form.resourceName} you can hardcode the JSON schema on the client.\n *\n * @remarks\n *\n * Use this when you want to avoid fetching metadata from the server but be aware that it could get out of sync if metadata changes on the server\n *\n * @public\n */\n",
628
- "excerptTokens": [
629
- {
630
- "kind": "Content",
631
- "text": "jsonSchema: "
632
- },
633
- {
634
- "kind": "Reference",
635
- "text": "JSONSchema7",
636
- "canonicalReference": "@types/json-schema!JSONSchema7:interface"
637
- },
638
- {
639
- "kind": "Content",
640
- "text": ";"
641
- }
642
- ],
643
- "isReadonly": false,
644
- "isOptional": false,
645
- "releaseTag": "Public",
646
- "name": "jsonSchema",
647
- "propertyTypeTokenRange": {
648
- "startIndex": 1,
649
- "endIndex": 2
650
- },
651
- "isStatic": false,
652
- "isProtected": false,
653
- "isAbstract": false
654
- },
655
- {
656
- "kind": "Property",
657
- "canonicalReference": "@genesislcap/foundation-forms!Form#readonly:member",
658
- "docComment": "",
659
- "excerptTokens": [
660
- {
661
- "kind": "Content",
662
- "text": "readonly: "
663
- },
664
- {
665
- "kind": "Content",
666
- "text": "boolean"
667
- },
668
- {
669
- "kind": "Content",
670
- "text": ";"
671
- }
672
- ],
673
- "isReadonly": false,
674
- "isOptional": false,
675
- "releaseTag": "Beta",
676
- "name": "readonly",
677
- "propertyTypeTokenRange": {
678
- "startIndex": 1,
679
- "endIndex": 2
680
- },
681
- "isStatic": false,
682
- "isProtected": false,
683
- "isAbstract": false
684
- },
685
- {
686
- "kind": "Property",
687
- "canonicalReference": "@genesislcap/foundation-forms!Form#renderers:member",
688
- "docComment": "/**\n * Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs\n *\n * @public\n */\n",
689
- "excerptTokens": [
690
- {
691
- "kind": "Content",
692
- "text": "renderers: "
693
- },
694
- {
695
- "kind": "Reference",
696
- "text": "RendererEntry",
697
- "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type"
698
- },
699
- {
700
- "kind": "Content",
701
- "text": "[]"
702
- },
703
- {
704
- "kind": "Content",
705
- "text": ";"
706
- }
707
- ],
708
- "isReadonly": false,
709
- "isOptional": false,
710
- "releaseTag": "Public",
711
- "name": "renderers",
712
- "propertyTypeTokenRange": {
713
- "startIndex": 1,
714
- "endIndex": 3
715
- },
716
- "isStatic": false,
717
- "isProtected": false,
718
- "isAbstract": false
719
- },
720
- {
721
- "kind": "Property",
722
- "canonicalReference": "@genesislcap/foundation-forms!Form#resourceName:member",
723
- "docComment": "/**\n * Name of the backend resource which will provide metadata used to generate form and later used for submitting data\n *\n * @public\n */\n",
724
- "excerptTokens": [
725
- {
726
- "kind": "Content",
727
- "text": "resourceName: "
728
- },
729
- {
730
- "kind": "Content",
731
- "text": "string"
732
- },
733
- {
734
- "kind": "Content",
735
- "text": ";"
736
- }
737
- ],
738
- "isReadonly": false,
739
- "isOptional": false,
740
- "releaseTag": "Public",
741
- "name": "resourceName",
742
- "propertyTypeTokenRange": {
743
- "startIndex": 1,
744
- "endIndex": 2
745
- },
746
- "isStatic": false,
747
- "isProtected": false,
748
- "isAbstract": false
749
- },
750
- {
751
- "kind": "Property",
752
- "canonicalReference": "@genesislcap/foundation-forms!Form#uischema:member",
753
- "docComment": "/**\n * UI schema used to define configuration of the layout and elements in the form Check {@link UiSchemaElement} for possible options\n *\n * @remarks\n *\n * If not provided will be autogenerated based on json schema or initial data\n *\n * @example\n *\n * Here's a simple example:\n * ```\n * const sampleUISchema = {\n * type: 'VerticalLayout',\n * elements: [\n * {\n * type: 'Control',\n * scope: '#/properties/QUANTITY',\n * label: 'Quantity',\n * },\n * {\n * type: 'Control',\n * scope: '#/properties/INSTRUMENT_ID',\n * options: {\n * allOptionsResourceName: 'INSTRUMENT',\n * valueField: 'INSTRUMENT_ID',\n * labelField: 'INSTRUMENT_ID',\n * },\n * label: 'Instrument',\n * },\n * {\n * type: 'Control',\n * scope: '#/properties/SIDE',\n * label: 'Side',\n * },\n * ],\n * };\n * ```\n *\n * @public\n */\n",
754
- "excerptTokens": [
755
- {
756
- "kind": "Content",
757
- "text": "uischema: "
758
- },
759
- {
760
- "kind": "Reference",
761
- "text": "UISchemaElement",
762
- "canonicalReference": "@jsonforms/core!UISchemaElement:interface"
763
- },
764
- {
765
- "kind": "Content",
766
- "text": ";"
767
- }
768
- ],
769
- "isReadonly": false,
770
- "isOptional": false,
771
- "releaseTag": "Public",
772
- "name": "uischema",
773
- "propertyTypeTokenRange": {
774
- "startIndex": 1,
775
- "endIndex": 2
776
- },
777
- "isStatic": false,
778
- "isProtected": false,
779
- "isAbstract": false
780
- }
781
- ],
782
- "extendsTokenRange": {
783
- "startIndex": 1,
784
- "endIndex": 2
785
- },
786
- "implementsTokenRanges": []
787
- },
788
- {
789
- "kind": "Variable",
790
- "canonicalReference": "@genesislcap/foundation-forms!genesisErrorTranslator:var",
791
- "docComment": "/**\n * @public\n */\n",
792
- "excerptTokens": [
793
- {
794
- "kind": "Content",
795
- "text": "genesisErrorTranslator: "
796
- },
797
- {
798
- "kind": "Reference",
799
- "text": "ErrorTranslator",
800
- "canonicalReference": "@jsonforms/core!ErrorTranslator:type"
801
- }
802
- ],
803
- "fileUrlPath": "src/utils/translation.ts",
804
- "isReadonly": true,
805
- "releaseTag": "Public",
806
- "name": "genesisErrorTranslator",
807
- "variableTypeTokenRange": {
808
- "startIndex": 1,
809
- "endIndex": 2
810
- }
811
- },
812
- {
813
- "kind": "Variable",
814
- "canonicalReference": "@genesislcap/foundation-forms!mustMatch:var",
815
- "docComment": "/**\n * Ensures the value of the current field (the one the validator is on) matches the one of the target field.\n *\n * @param target - any other field\n *\n * @returns a validator function that will be run by the smart form during the client-side validation stage\n *\n * @public\n */\n",
816
- "excerptTokens": [
817
- {
818
- "kind": "Content",
819
- "text": "mustMatch: "
820
- },
821
- {
822
- "kind": "Content",
823
- "text": "(target: string) => (data: any, path: any, label: any) => {\n instancePath: string;\n message: string;\n schemaPath: string;\n keyword: string;\n params: {};\n}[]"
824
- }
825
- ],
826
- "fileUrlPath": "src/utils/validation.ts",
827
- "isReadonly": true,
828
- "releaseTag": "Public",
829
- "name": "mustMatch",
830
- "variableTypeTokenRange": {
831
- "startIndex": 1,
832
- "endIndex": 2
833
- }
834
- },
835
- {
836
- "kind": "TypeAlias",
837
- "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type",
838
- "docComment": "/**\n * @public\n */\n",
839
- "excerptTokens": [
840
- {
841
- "kind": "Content",
842
- "text": "export type RendererEntry = "
843
- },
844
- {
845
- "kind": "Content",
846
- "text": "{\n renderer: "
847
- },
848
- {
849
- "kind": "Reference",
850
- "text": "ViewTemplate",
851
- "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
852
- },
853
- {
854
- "kind": "Content",
855
- "text": "<"
856
- },
857
- {
858
- "kind": "Reference",
859
- "text": "DispatchRenderer",
860
- "canonicalReference": "@genesislcap/foundation-forms!~DispatchRenderer:class"
861
- },
862
- {
863
- "kind": "Content",
864
- "text": ", any>;\n tester: "
865
- },
866
- {
867
- "kind": "Reference",
868
- "text": "RankedTester",
869
- "canonicalReference": "@jsonforms/core!RankedTester:type"
870
- },
871
- {
872
- "kind": "Content",
873
- "text": ";\n mapper: (state: "
874
- },
875
- {
876
- "kind": "Reference",
877
- "text": "JsonFormsState",
878
- "canonicalReference": "@jsonforms/core!JsonFormsState:interface"
879
- },
880
- {
881
- "kind": "Content",
882
- "text": ", ownProps: "
883
- },
884
- {
885
- "kind": "Reference",
886
- "text": "OwnPropsOfControl",
887
- "canonicalReference": "@jsonforms/core!OwnPropsOfControl:interface"
888
- },
889
- {
890
- "kind": "Content",
891
- "text": ") => "
892
- },
893
- {
894
- "kind": "Reference",
895
- "text": "StatePropsOfControl",
896
- "canonicalReference": "@jsonforms/core!StatePropsOfControl:interface"
897
- },
898
- {
899
- "kind": "Content",
900
- "text": ";\n}"
901
- },
902
- {
903
- "kind": "Content",
904
- "text": ";"
905
- }
906
- ],
907
- "fileUrlPath": "src/types.ts",
908
- "releaseTag": "Public",
909
- "name": "RendererEntry",
910
- "typeTokenRange": {
911
- "startIndex": 1,
912
- "endIndex": 14
913
- }
914
- },
915
- {
916
- "kind": "Variable",
917
- "canonicalReference": "@genesislcap/foundation-forms!renderers:var",
918
- "docComment": "/**\n * @public\n */\n",
919
- "excerptTokens": [
920
- {
921
- "kind": "Content",
922
- "text": "renderers: "
923
- },
924
- {
925
- "kind": "Content",
926
- "text": "any[]"
927
- }
928
- ],
929
- "fileUrlPath": "src/form.ts",
930
- "isReadonly": true,
931
- "releaseTag": "Public",
932
- "name": "renderers",
933
- "variableTypeTokenRange": {
934
- "startIndex": 1,
935
- "endIndex": 2
936
- }
937
- },
938
- {
939
- "kind": "TypeAlias",
940
- "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type",
941
- "docComment": "/**\n * @public\n */\n",
942
- "excerptTokens": [
943
- {
944
- "kind": "Content",
945
- "text": "export type UiSchema = "
946
- },
947
- {
948
- "kind": "Content",
949
- "text": "{\n type: "
950
- },
951
- {
952
- "kind": "Reference",
953
- "text": "UiSchemaElementType",
954
- "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementType:type"
955
- },
956
- {
957
- "kind": "Content",
958
- "text": ";\n elements: "
959
- },
960
- {
961
- "kind": "Reference",
962
- "text": "UiSchemaElement",
963
- "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElement:type"
964
- },
965
- {
966
- "kind": "Content",
967
- "text": "[];\n}"
968
- },
969
- {
970
- "kind": "Content",
971
- "text": ";"
972
- }
973
- ],
974
- "fileUrlPath": "src/types.ts",
975
- "releaseTag": "Public",
976
- "name": "UiSchema",
977
- "typeTokenRange": {
978
- "startIndex": 1,
979
- "endIndex": 6
980
- }
981
- },
982
- {
983
- "kind": "TypeAlias",
984
- "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElement:type",
985
- "docComment": "/**\n * @public\n */\n",
986
- "excerptTokens": [
987
- {
988
- "kind": "Content",
989
- "text": "export type UiSchemaElement = "
990
- },
991
- {
992
- "kind": "Content",
993
- "text": "{\n type: "
994
- },
995
- {
996
- "kind": "Reference",
997
- "text": "UiSchemaElementType",
998
- "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementType:type"
999
- },
1000
- {
1001
- "kind": "Content",
1002
- "text": ";\n scope: string;\n label?: string;\n options?: "
1003
- },
1004
- {
1005
- "kind": "Reference",
1006
- "text": "UiSchemaElementOptions",
1007
- "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementOptions:type"
1008
- },
1009
- {
1010
- "kind": "Content",
1011
- "text": ";\n}"
1012
- },
1013
- {
1014
- "kind": "Content",
1015
- "text": ";"
1016
- }
1017
- ],
1018
- "fileUrlPath": "src/types.ts",
1019
- "releaseTag": "Public",
1020
- "name": "UiSchemaElement",
1021
- "typeTokenRange": {
1022
- "startIndex": 1,
1023
- "endIndex": 6
1024
- }
1025
- },
1026
- {
1027
- "kind": "TypeAlias",
1028
- "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementOptions:type",
1029
- "docComment": "/**\n * @public\n */\n",
1030
- "excerptTokens": [
1031
- {
1032
- "kind": "Content",
1033
- "text": "export type UiSchemaElementOptions = "
1034
- },
1035
- {
1036
- "kind": "Content",
1037
- "text": "{\n allOptionsResourceName?: string;\n datasourceConfig?: "
1038
- },
1039
- {
1040
- "kind": "Reference",
1041
- "text": "DatasourceOptions",
1042
- "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions:interface"
1043
- },
1044
- {
1045
- "kind": "Content",
1046
- "text": ";\n hidden?: boolean;\n isPassword?: boolean;\n validateFn?: (data: any, path: string, label: string) => "
1047
- },
1048
- {
1049
- "kind": "Reference",
1050
- "text": "ErrorObject",
1051
- "canonicalReference": "ajv!ErrorObject:interface"
1052
- },
1053
- {
1054
- "kind": "Content",
1055
- "text": "[];\n valueField?: string;\n labelField?: string;\n textarea?: boolean;\n data?: any[];\n i18n?: {\n [key: string]: any;\n };\n}"
1056
- },
1057
- {
1058
- "kind": "Content",
1059
- "text": ";"
1060
- }
1061
- ],
1062
- "fileUrlPath": "src/types.ts",
1063
- "releaseTag": "Public",
1064
- "name": "UiSchemaElementOptions",
1065
- "typeTokenRange": {
1066
- "startIndex": 1,
1067
- "endIndex": 6
1068
- }
1069
- },
1070
- {
1071
- "kind": "TypeAlias",
1072
- "canonicalReference": "@genesislcap/foundation-forms!UiSchemaElementType:type",
1073
- "docComment": "/**\n * @public\n */\n",
1074
- "excerptTokens": [
1075
- {
1076
- "kind": "Content",
1077
- "text": "export type UiSchemaElementType = "
1078
- },
1079
- {
1080
- "kind": "Content",
1081
- "text": "'Control' | 'VerticalLayout' | any"
1082
- },
1083
- {
1084
- "kind": "Content",
1085
- "text": ";"
1086
- }
1087
- ],
1088
- "fileUrlPath": "src/types.ts",
1089
- "releaseTag": "Public",
1090
- "name": "UiSchemaElementType",
1091
- "typeTokenRange": {
1092
- "startIndex": 1,
1093
- "endIndex": 2
1094
- }
1095
- }
1096
- ]
1097
- }
1098
- ]
1099
- }