@genesislcap/foundation-forms 14.449.0 → 14.449.1-alpha-12eee28.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 (2) hide show
  1. package/dist/custom-elements.json +820 -820
  2. package/package.json +15 -15
@@ -951,1106 +951,1106 @@
951
951
  },
952
952
  {
953
953
  "kind": "javascript-module",
954
- "path": "src/filters/filters.styles.ts",
955
- "declarations": [
956
- {
957
- "kind": "variable",
958
- "name": "foundationFiltersStyles"
959
- }
960
- ],
961
- "exports": [
962
- {
963
- "kind": "js",
964
- "name": "foundationFiltersStyles",
965
- "declaration": {
966
- "name": "foundationFiltersStyles",
967
- "module": "src/filters/filters.styles.ts"
968
- }
969
- }
970
- ]
971
- },
972
- {
973
- "kind": "javascript-module",
974
- "path": "src/filters/filters.template.ts",
954
+ "path": "src/utils/confirmation-dialog-utils.ts",
975
955
  "declarations": [],
976
956
  "exports": []
977
957
  },
978
958
  {
979
959
  "kind": "javascript-module",
980
- "path": "src/filters/filters.ts",
960
+ "path": "src/utils/csv-parser.ts",
981
961
  "declarations": [
982
962
  {
983
- "kind": "variable",
984
- "name": "filtersRenderers",
985
- "type": {
986
- "text": "array"
963
+ "kind": "function",
964
+ "name": "parseCsv",
965
+ "return": {
966
+ "type": {
967
+ "text": ""
968
+ }
987
969
  },
988
- "default": "[\n fallbackEntry,\n stringEntry,\n BooleanControlEntry,\n LayoutVertical2ColumnsEntry,\n LayoutRendererEntry,\n FilterNumberControlRendererEntry,\n ConnectedMultiselectControlRendererEntry,\n EnumControlRendererEntry,\n ConnectedSelectControlRendererEntry,\n FilterDateControlRendererEntry,\n FilterTimeControlRendererEntry,\n InvisibleControlEntry,\n]",
989
- "description": "Set of default renderers used by the foundation-filters.",
970
+ "parameters": [
971
+ {
972
+ "name": "content",
973
+ "type": {
974
+ "text": "string"
975
+ },
976
+ "description": "The CSV content as a string"
977
+ }
978
+ ],
979
+ "description": "Parses a CSV string into headers and rows using PapaParse.\nHandles quoted fields, escaped quotes, empty values, and mixed line endings.",
990
980
  "privacy": "public"
991
981
  },
992
982
  {
993
- "kind": "class",
994
- "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",
995
- "name": "Filters",
996
- "members": [
997
- {
998
- "kind": "field",
999
- "name": "kvStorage",
1000
- "type": {
1001
- "text": "KVStorage"
1002
- }
1003
- },
983
+ "kind": "function",
984
+ "name": "mapCsvToSchema",
985
+ "return": {
986
+ "type": {
987
+ "text": ""
988
+ }
989
+ },
990
+ "parameters": [
1004
991
  {
1005
- "kind": "field",
1006
- "name": "filterName",
992
+ "name": "csvRows",
1007
993
  "type": {
1008
- "text": "string"
1009
- }
994
+ "text": "Record<string, string>[]"
995
+ },
996
+ "description": "The parsed CSV rows"
1010
997
  },
1011
998
  {
1012
- "kind": "field",
1013
- "name": "resourceName",
999
+ "name": "schema",
1014
1000
  "type": {
1015
- "text": "string"
1001
+ "text": "JSONSchema7 | undefined"
1016
1002
  },
1017
- "description": "Name of the backend resource which will provide metadata\nused to generate filters.",
1018
- "privacy": "public"
1003
+ "description": "The JSON schema defining the fields"
1019
1004
  },
1020
1005
  {
1021
- "kind": "field",
1022
- "name": "allSavedFilters",
1006
+ "name": "uiSchema",
1007
+ "optional": true,
1023
1008
  "type": {
1024
- "text": "any[]"
1009
+ "text": "UiSchema"
1025
1010
  },
1026
- "default": "[]"
1027
- },
1011
+ "description": "Optional UI schema to map labels to field names on import"
1012
+ }
1013
+ ],
1014
+ "description": "Maps CSV rows to schema fields with case-insensitive matching.\nWhen uiSchema is provided, CSV headers can also match UI schema labels.\nConverts values to appropriate types based on schema definition.",
1015
+ "privacy": "public"
1016
+ },
1017
+ {
1018
+ "kind": "function",
1019
+ "name": "generateCsvTemplate",
1020
+ "return": {
1021
+ "type": {
1022
+ "text": ""
1023
+ }
1024
+ },
1025
+ "parameters": [
1028
1026
  {
1029
- "kind": "field",
1030
- "name": "showFilterPersistenceControls",
1027
+ "name": "schema",
1031
1028
  "type": {
1032
- "text": "boolean"
1029
+ "text": "JSONSchema7 | undefined"
1033
1030
  },
1034
- "description": "Controls the visibility of the filter persistence controls UI.",
1035
- "privacy": "public"
1036
- },
1037
- {
1038
- "kind": "method",
1039
- "name": "resourceNameChanged",
1040
- "privacy": "private"
1031
+ "description": "The JSON schema defining the fields"
1041
1032
  },
1042
1033
  {
1043
- "kind": "field",
1044
- "name": "uischema",
1034
+ "name": "uiSchema",
1035
+ "optional": true,
1045
1036
  "type": {
1046
1037
  "text": "UiSchema"
1047
1038
  },
1048
- "description": "UI schema used to define configuration of the layout and elements in the filters\nCheck UiSchema for possible options.",
1049
- "privacy": "public"
1039
+ "description": "Optional UI schema to determine field order and visibility"
1050
1040
  },
1051
1041
  {
1052
- "kind": "field",
1053
- "name": "renderers",
1042
+ "name": "includeOptionalFields",
1043
+ "default": "true",
1054
1044
  "type": {
1055
- "text": "RendererEntry[]"
1045
+ "text": "boolean"
1056
1046
  },
1057
- "default": "[\n fallbackEntry,\n stringEntry,\n BooleanControlEntry,\n LayoutVertical2ColumnsEntry,\n LayoutRendererEntry,\n FilterNumberControlRendererEntry,\n ConnectedMultiselectControlRendererEntry,\n EnumControlRendererEntry,\n ConnectedSelectControlRendererEntry,\n FilterDateControlRendererEntry,\n FilterTimeControlRendererEntry,\n InvisibleControlEntry,\n]",
1058
- "description": "Allows to provide the main set of renderers used by the form. If not provided, the built-in renderers will be used by default.",
1059
- "privacy": "public"
1047
+ "description": "Whether to include optional fields when no UI schema (default: true)"
1060
1048
  },
1061
1049
  {
1062
- "kind": "field",
1063
- "name": "jsonSchema",
1050
+ "name": "includeBom",
1051
+ "default": "true",
1064
1052
  "type": {
1065
- "text": "JSONSchema7"
1053
+ "text": "boolean"
1066
1054
  },
1067
- "description": "Alternatively to providing Form.resourceName you can hardcode the JSON schema on the client.",
1068
- "privacy": "public"
1069
- },
1055
+ "description": "Whether to prepend UTF-8 BOM for Excel compatibility (default: true)"
1056
+ }
1057
+ ],
1058
+ "description": "Generates a CSV template string with headers and sample data based on JSON schema.\nIf a UI schema is provided, it will be used to determine which fields to include\nand in what order. Hidden fields in the UI schema will be excluded.",
1059
+ "privacy": "public"
1060
+ },
1061
+ {
1062
+ "kind": "function",
1063
+ "name": "downloadCsvTemplate",
1064
+ "return": {
1065
+ "type": {
1066
+ "text": "void"
1067
+ }
1068
+ },
1069
+ "parameters": [
1070
1070
  {
1071
- "kind": "field",
1072
- "name": "prefix",
1071
+ "name": "csvContent",
1073
1072
  "type": {
1074
1073
  "text": "string"
1075
1074
  },
1076
- "default": "'rapid'",
1077
- "description": "Name of the design system prefix that will be used in renderers.",
1078
- "privacy": "public"
1075
+ "description": "The CSV content to download"
1079
1076
  },
1080
1077
  {
1081
- "kind": "field",
1082
- "name": "connect",
1078
+ "name": "fileName",
1079
+ "default": "'template.csv'",
1083
1080
  "type": {
1084
- "text": "Connect"
1081
+ "text": "string"
1085
1082
  },
1086
- "privacy": "private"
1087
- },
1083
+ "description": "The name for the downloaded file (default: 'template.csv')"
1084
+ }
1085
+ ],
1086
+ "description": "Triggers a download of the CSV template file in the browser.",
1087
+ "privacy": "public"
1088
+ }
1089
+ ],
1090
+ "exports": [
1091
+ {
1092
+ "kind": "js",
1093
+ "name": "parseCsv",
1094
+ "declaration": {
1095
+ "name": "parseCsv",
1096
+ "module": "src/utils/csv-parser.ts"
1097
+ }
1098
+ },
1099
+ {
1100
+ "kind": "js",
1101
+ "name": "mapCsvToSchema",
1102
+ "declaration": {
1103
+ "name": "mapCsvToSchema",
1104
+ "module": "src/utils/csv-parser.ts"
1105
+ }
1106
+ },
1107
+ {
1108
+ "kind": "js",
1109
+ "name": "generateCsvTemplate",
1110
+ "declaration": {
1111
+ "name": "generateCsvTemplate",
1112
+ "module": "src/utils/csv-parser.ts"
1113
+ }
1114
+ },
1115
+ {
1116
+ "kind": "js",
1117
+ "name": "downloadCsvTemplate",
1118
+ "declaration": {
1119
+ "name": "downloadCsvTemplate",
1120
+ "module": "src/utils/csv-parser.ts"
1121
+ }
1122
+ }
1123
+ ]
1124
+ },
1125
+ {
1126
+ "kind": "javascript-module",
1127
+ "path": "src/utils/filters.ts",
1128
+ "declarations": [],
1129
+ "exports": []
1130
+ },
1131
+ {
1132
+ "kind": "javascript-module",
1133
+ "path": "src/utils/form-utils.ts",
1134
+ "declarations": [
1135
+ {
1136
+ "kind": "function",
1137
+ "name": "removeDataPropertiesNotInSchema",
1138
+ "return": {
1139
+ "type": {
1140
+ "text": ""
1141
+ }
1142
+ },
1143
+ "parameters": [
1088
1144
  {
1089
- "kind": "field",
1090
1145
  "name": "data",
1091
1146
  "type": {
1092
1147
  "text": "any"
1093
1148
  },
1094
- "default": "{}",
1095
- "description": "Initial data for the filters.",
1096
- "privacy": "public"
1149
+ "description": "The data object to clean"
1097
1150
  },
1098
1151
  {
1099
- "kind": "field",
1100
- "name": "value",
1152
+ "name": "jsonSchema",
1101
1153
  "type": {
1102
- "text": "string"
1154
+ "text": "JSONSchema7"
1103
1155
  },
1104
- "description": "Created criteria based on the given data that can be used to filter the data.",
1105
- "privacy": "public"
1106
- },
1107
- {
1108
- "kind": "method",
1109
- "name": "saveFilter"
1110
- },
1111
- {
1112
- "kind": "method",
1113
- "name": "deleteFilter"
1114
- },
1115
- {
1116
- "kind": "method",
1117
- "name": "loadAllSavedFilters"
1118
- },
1119
- {
1120
- "kind": "method",
1121
- "name": "filterNameChanged",
1122
- "parameters": [
1123
- {
1124
- "name": "oldValue",
1125
- "type": {
1126
- "text": "string"
1127
- }
1128
- },
1129
- {
1130
- "name": "newValue",
1131
- "type": {
1132
- "text": "string"
1133
- }
1134
- }
1135
- ]
1136
- },
1137
- {
1138
- "kind": "method",
1139
- "name": "loadFilterData",
1140
- "parameters": [
1141
- {
1142
- "name": "filterKey",
1143
- "type": {
1144
- "text": "string"
1145
- }
1146
- }
1147
- ]
1148
- },
1149
- {
1150
- "kind": "method",
1151
- "name": "cloneNode",
1152
- "return": {
1153
- "type": {
1154
- "text": "Node"
1155
- }
1156
- },
1157
- "parameters": [
1158
- {
1159
- "name": "deep",
1160
- "optional": true,
1161
- "type": {
1162
- "text": "boolean"
1163
- }
1164
- }
1165
- ],
1166
- "inheritedFrom": {
1167
- "name": "LifecycleMixin",
1168
- "module": "src/mixins/lifecycle/lifecycle.ts"
1169
- }
1170
- },
1171
- {
1172
- "kind": "method",
1173
- "name": "deepClone",
1174
- "return": {
1175
- "type": {
1176
- "text": "Node"
1177
- }
1178
- },
1179
- "inheritedFrom": {
1180
- "name": "LifecycleMixin",
1181
- "module": "src/mixins/lifecycle/lifecycle.ts"
1182
- }
1183
- },
1184
- {
1185
- "kind": "field",
1186
- "name": "shouldRunDisconnect",
1187
- "return": {
1188
- "type": {
1189
- "text": ""
1190
- }
1191
- },
1192
- "readonly": true,
1193
- "inheritedFrom": {
1194
- "name": "LifecycleMixin",
1195
- "module": "src/mixins/lifecycle/lifecycle.ts"
1196
- }
1197
- },
1198
- {
1199
- "kind": "field",
1200
- "name": "shouldRunConnect",
1201
- "return": {
1202
- "type": {
1203
- "text": ""
1204
- }
1205
- },
1206
- "readonly": true,
1207
- "inheritedFrom": {
1208
- "name": "LifecycleMixin",
1209
- "module": "src/mixins/lifecycle/lifecycle.ts"
1210
- }
1211
- },
1212
- {
1213
- "kind": "method",
1214
- "name": "#_blockLifecycleDueToTokenChange",
1215
- "return": {
1216
- "type": {
1217
- "text": "boolean"
1218
- }
1219
- },
1220
- "parameters": [
1221
- {
1222
- "name": "lifecycleType",
1223
- "type": {
1224
- "text": "Lifecycletype"
1225
- }
1226
- }
1227
- ],
1228
- "inheritedFrom": {
1229
- "name": "LifecycleMixin",
1230
- "module": "src/mixins/lifecycle/lifecycle.ts"
1231
- }
1232
- },
1233
- {
1234
- "kind": "field",
1235
- "name": "_presentation",
1236
- "type": {
1237
- "text": "ComponentPresentation | null | undefined"
1238
- },
1239
- "privacy": "private",
1240
- "default": "void 0",
1241
- "inheritedFrom": {
1242
- "name": "FoundationElement",
1243
- "module": "src/foundation-element/foundation-element.ts"
1244
- }
1245
- },
1246
- {
1247
- "kind": "field",
1248
- "name": "$presentation",
1249
- "type": {
1250
- "text": "ComponentPresentation | null"
1251
- },
1252
- "privacy": "public",
1253
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
1254
- "inheritedFrom": {
1255
- "name": "FoundationElement",
1256
- "module": "src/foundation-element/foundation-element.ts"
1257
- }
1258
- },
1259
- {
1260
- "kind": "field",
1261
- "name": "template",
1262
- "type": {
1263
- "text": "ElementViewTemplate | void | null"
1264
- },
1265
- "privacy": "public",
1266
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
1267
- "inheritedFrom": {
1268
- "name": "FoundationElement",
1269
- "module": "src/foundation-element/foundation-element.ts"
1270
- }
1271
- },
1272
- {
1273
- "kind": "method",
1274
- "name": "templateChanged",
1275
- "privacy": "protected",
1276
- "return": {
1277
- "type": {
1278
- "text": "void"
1279
- }
1280
- },
1281
- "inheritedFrom": {
1282
- "name": "FoundationElement",
1283
- "module": "src/foundation-element/foundation-element.ts"
1284
- }
1285
- },
1286
- {
1287
- "kind": "field",
1288
- "name": "styles",
1289
- "type": {
1290
- "text": "ElementStyles | void | null"
1291
- },
1292
- "privacy": "public",
1293
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
1294
- "inheritedFrom": {
1295
- "name": "FoundationElement",
1296
- "module": "src/foundation-element/foundation-element.ts"
1297
- }
1298
- },
1299
- {
1300
- "kind": "method",
1301
- "name": "stylesChanged",
1302
- "privacy": "protected",
1303
- "return": {
1304
- "type": {
1305
- "text": "void"
1306
- }
1307
- },
1308
- "inheritedFrom": {
1309
- "name": "FoundationElement",
1310
- "module": "src/foundation-element/foundation-element.ts"
1311
- }
1312
- },
1313
- {
1314
- "kind": "method",
1315
- "name": "compose",
1316
- "privacy": "public",
1317
- "static": true,
1318
- "return": {
1319
- "type": {
1320
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
1321
- }
1322
- },
1323
- "parameters": [
1324
- {
1325
- "name": "this",
1326
- "type": {
1327
- "text": "K"
1328
- }
1329
- },
1330
- {
1331
- "name": "elementDefinition",
1332
- "type": {
1333
- "text": "T"
1334
- },
1335
- "description": "The definition of the element to create the registry\nfunction for."
1336
- }
1337
- ],
1338
- "description": "Defines an element registry function with a set of element definition defaults.",
1339
- "inheritedFrom": {
1340
- "name": "FoundationElement",
1341
- "module": "src/foundation-element/foundation-element.ts"
1342
- }
1156
+ "description": "The JSON schema to validate against"
1343
1157
  }
1344
1158
  ],
1345
- "events": [
1159
+ "description": "Removes data properties that aren't part of the schema"
1160
+ }
1161
+ ],
1162
+ "exports": [
1163
+ {
1164
+ "kind": "js",
1165
+ "name": "removeDataPropertiesNotInSchema",
1166
+ "declaration": {
1167
+ "name": "removeDataPropertiesNotInSchema",
1168
+ "module": "src/utils/form-utils.ts"
1169
+ }
1170
+ }
1171
+ ]
1172
+ },
1173
+ {
1174
+ "kind": "javascript-module",
1175
+ "path": "src/utils/index.ts",
1176
+ "declarations": [],
1177
+ "exports": [
1178
+ {
1179
+ "kind": "js",
1180
+ "name": "*",
1181
+ "declaration": {
1182
+ "name": "*",
1183
+ "package": "./csv-parser"
1184
+ }
1185
+ },
1186
+ {
1187
+ "kind": "js",
1188
+ "name": "*",
1189
+ "declaration": {
1190
+ "name": "*",
1191
+ "package": "./filters"
1192
+ }
1193
+ },
1194
+ {
1195
+ "kind": "js",
1196
+ "name": "*",
1197
+ "declaration": {
1198
+ "name": "*",
1199
+ "package": "./logger"
1200
+ }
1201
+ },
1202
+ {
1203
+ "kind": "js",
1204
+ "name": "*",
1205
+ "declaration": {
1206
+ "name": "*",
1207
+ "package": "./translation"
1208
+ }
1209
+ },
1210
+ {
1211
+ "kind": "js",
1212
+ "name": "*",
1213
+ "declaration": {
1214
+ "name": "*",
1215
+ "package": "./validation"
1216
+ }
1217
+ },
1218
+ {
1219
+ "kind": "js",
1220
+ "name": "*",
1221
+ "declaration": {
1222
+ "name": "*",
1223
+ "package": "./types"
1224
+ }
1225
+ }
1226
+ ]
1227
+ },
1228
+ {
1229
+ "kind": "javascript-module",
1230
+ "path": "src/utils/logger.ts",
1231
+ "declarations": [],
1232
+ "exports": []
1233
+ },
1234
+ {
1235
+ "kind": "javascript-module",
1236
+ "path": "src/utils/schema-utils.ts",
1237
+ "declarations": [],
1238
+ "exports": []
1239
+ },
1240
+ {
1241
+ "kind": "javascript-module",
1242
+ "path": "src/utils/translation.ts",
1243
+ "declarations": [],
1244
+ "exports": []
1245
+ },
1246
+ {
1247
+ "kind": "javascript-module",
1248
+ "path": "src/utils/types.ts",
1249
+ "declarations": [],
1250
+ "exports": []
1251
+ },
1252
+ {
1253
+ "kind": "javascript-module",
1254
+ "path": "src/utils/validation.ts",
1255
+ "declarations": [
1256
+ {
1257
+ "kind": "function",
1258
+ "name": "mustMatch",
1259
+ "parameters": [
1346
1260
  {
1347
- "name": "change",
1261
+ "name": "target",
1348
1262
  "type": {
1349
- "text": "CustomEvent"
1263
+ "text": "string"
1350
1264
  },
1351
- "description": "Fired when built criteria (`value`) updates"
1352
- },
1353
- {
1354
- "description": "Fired when filter values are submitted",
1355
- "name": "submit"
1265
+ "description": "any other field"
1356
1266
  }
1357
1267
  ],
1358
- "attributes": [
1268
+ "description": "Ensures the value of the current field (the one the validator is on) matches the one of the target field.",
1269
+ "return": {
1270
+ "type": {
1271
+ "text": ""
1272
+ }
1273
+ },
1274
+ "privacy": "public"
1275
+ },
1276
+ {
1277
+ "kind": "function",
1278
+ "name": "getAnyOfErrorMessage",
1279
+ "return": {
1280
+ "type": {
1281
+ "text": "string"
1282
+ }
1283
+ },
1284
+ "parameters": [
1285
+ {
1286
+ "name": "errors",
1287
+ "type": {
1288
+ "text": "Array<any> | undefined"
1289
+ }
1290
+ },
1359
1291
  {
1360
- "name": "resourceName",
1292
+ "name": "schema",
1361
1293
  "type": {
1362
- "text": "string"
1363
- },
1364
- "description": "Name of the backend resource which will provide metadata\nused to generate filters.",
1365
- "fieldName": "resourceName"
1294
+ "text": "any"
1295
+ }
1366
1296
  },
1367
1297
  {
1368
- "name": "show-filter-persistence-controls",
1298
+ "name": "controlPath",
1369
1299
  "type": {
1370
- "text": "boolean"
1371
- },
1372
- "description": "Controls the visibility of the filter persistence controls UI.",
1373
- "fieldName": "showFilterPersistenceControls"
1300
+ "text": "string | undefined"
1301
+ }
1374
1302
  },
1375
1303
  {
1376
- "name": "design-system-prefix",
1304
+ "name": "uiCustomMsg",
1305
+ "optional": true,
1377
1306
  "type": {
1378
1307
  "text": "string"
1379
- },
1380
- "default": "'rapid'",
1381
- "description": "Name of the design system prefix that will be used in renderers.",
1382
- "fieldName": "prefix"
1383
- }
1384
- ],
1385
- "mixins": [
1386
- {
1387
- "name": "LifecycleMixin",
1388
- "package": "@genesislcap/foundation-utils"
1308
+ }
1389
1309
  }
1390
1310
  ],
1391
- "superclass": {
1392
- "name": "FoundationElement",
1393
- "package": "@microsoft/fast-foundation"
1394
- },
1395
- "tagName": "foundation-filters",
1396
- "customElement": true
1311
+ "description": "Computes a human-friendly anyOf error message for a given control path.\nPrefers UI schema custom message, then JSON schema errorMessage.anyOf, then a constructed fallback.",
1312
+ "privacy": "public"
1397
1313
  }
1398
1314
  ],
1399
1315
  "exports": [
1400
1316
  {
1401
1317
  "kind": "js",
1402
- "name": "filtersRenderers",
1318
+ "name": "mustMatch",
1403
1319
  "declaration": {
1404
- "name": "filtersRenderers",
1405
- "module": "src/filters/filters.ts"
1320
+ "name": "mustMatch",
1321
+ "module": "src/utils/validation.ts"
1406
1322
  }
1407
1323
  },
1408
1324
  {
1409
1325
  "kind": "js",
1410
- "name": "Filters",
1411
- "declaration": {
1412
- "name": "Filters",
1413
- "module": "src/filters/filters.ts"
1414
- }
1415
- },
1416
- {
1417
- "kind": "custom-element-definition",
1418
- "name": "foundation-filters",
1326
+ "name": "getAnyOfErrorMessage",
1419
1327
  "declaration": {
1420
- "name": "Filters",
1421
- "module": "src/filters/filters.ts"
1328
+ "name": "getAnyOfErrorMessage",
1329
+ "module": "src/utils/validation.ts"
1422
1330
  }
1423
1331
  }
1424
1332
  ]
1425
1333
  },
1426
1334
  {
1427
1335
  "kind": "javascript-module",
1428
- "path": "src/filters/index.ts",
1429
- "declarations": [],
1336
+ "path": "src/filters/filters.styles.ts",
1337
+ "declarations": [
1338
+ {
1339
+ "kind": "variable",
1340
+ "name": "foundationFiltersStyles"
1341
+ }
1342
+ ],
1430
1343
  "exports": [
1431
1344
  {
1432
1345
  "kind": "js",
1433
- "name": "*",
1346
+ "name": "foundationFiltersStyles",
1434
1347
  "declaration": {
1435
- "name": "*",
1436
- "package": "./filters"
1348
+ "name": "foundationFiltersStyles",
1349
+ "module": "src/filters/filters.styles.ts"
1437
1350
  }
1438
1351
  }
1439
1352
  ]
1440
1353
  },
1441
1354
  {
1442
1355
  "kind": "javascript-module",
1443
- "path": "src/jsonforms/json-forms.ts",
1356
+ "path": "src/filters/filters.template.ts",
1357
+ "declarations": [],
1358
+ "exports": []
1359
+ },
1360
+ {
1361
+ "kind": "javascript-module",
1362
+ "path": "src/filters/filters.ts",
1444
1363
  "declarations": [
1364
+ {
1365
+ "kind": "variable",
1366
+ "name": "filtersRenderers",
1367
+ "type": {
1368
+ "text": "array"
1369
+ },
1370
+ "default": "[\n fallbackEntry,\n stringEntry,\n BooleanControlEntry,\n LayoutVertical2ColumnsEntry,\n LayoutRendererEntry,\n FilterNumberControlRendererEntry,\n ConnectedMultiselectControlRendererEntry,\n EnumControlRendererEntry,\n ConnectedSelectControlRendererEntry,\n FilterDateControlRendererEntry,\n FilterTimeControlRendererEntry,\n InvisibleControlEntry,\n]",
1371
+ "description": "Set of default renderers used by the foundation-filters.",
1372
+ "privacy": "public"
1373
+ },
1445
1374
  {
1446
1375
  "kind": "class",
1447
- "description": "JSON Forms host element for schema-driven UI.",
1448
- "name": "JSONForms",
1376
+ "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",
1377
+ "name": "Filters",
1449
1378
  "members": [
1450
1379
  {
1451
1380
  "kind": "field",
1452
- "name": "_submitted",
1381
+ "name": "kvStorage",
1453
1382
  "type": {
1454
- "text": "boolean"
1455
- },
1456
- "privacy": "private",
1457
- "default": "false"
1383
+ "text": "KVStorage"
1384
+ }
1458
1385
  },
1459
1386
  {
1460
1387
  "kind": "field",
1461
- "name": "submitted",
1388
+ "name": "filterName",
1462
1389
  "type": {
1463
- "text": "boolean"
1390
+ "text": "string"
1464
1391
  }
1465
1392
  },
1466
1393
  {
1467
1394
  "kind": "field",
1468
- "name": "prefix"
1469
- },
1470
- {
1471
- "kind": "method",
1472
- "name": "prefixChanged"
1473
- },
1474
- {
1475
- "kind": "field",
1476
- "name": "jsonforms"
1477
- },
1478
- {
1479
- "kind": "field",
1480
- "name": "i18n"
1395
+ "name": "resourceName",
1396
+ "type": {
1397
+ "text": "string"
1398
+ },
1399
+ "description": "Name of the backend resource which will provide metadata\nused to generate filters.",
1400
+ "privacy": "public"
1481
1401
  },
1482
1402
  {
1483
1403
  "kind": "field",
1484
- "name": "uichemaToUse"
1404
+ "name": "allSavedFilters",
1405
+ "type": {
1406
+ "text": "any[]"
1407
+ },
1408
+ "default": "[]"
1485
1409
  },
1486
1410
  {
1487
1411
  "kind": "field",
1488
- "name": "schema"
1412
+ "name": "showFilterPersistenceControls",
1413
+ "type": {
1414
+ "text": "boolean"
1415
+ },
1416
+ "description": "Controls the visibility of the filter persistence controls UI.",
1417
+ "privacy": "public"
1489
1418
  },
1490
1419
  {
1491
1420
  "kind": "method",
1492
- "name": "schemaChanged"
1421
+ "name": "resourceNameChanged",
1422
+ "privacy": "private"
1493
1423
  },
1494
1424
  {
1495
1425
  "kind": "field",
1496
1426
  "name": "uischema",
1497
1427
  "type": {
1498
- "text": "UISchemaElement"
1499
- }
1500
- },
1501
- {
1502
- "kind": "method",
1503
- "name": "uischemaChanged"
1428
+ "text": "UiSchema"
1429
+ },
1430
+ "description": "UI schema used to define configuration of the layout and elements in the filters\nCheck UiSchema for possible options.",
1431
+ "privacy": "public"
1504
1432
  },
1505
1433
  {
1506
1434
  "kind": "field",
1507
- "name": "data"
1508
- },
1509
- {
1510
- "kind": "method",
1511
- "name": "dataChanged"
1435
+ "name": "renderers",
1436
+ "type": {
1437
+ "text": "RendererEntry[]"
1438
+ },
1439
+ "default": "[\n fallbackEntry,\n stringEntry,\n BooleanControlEntry,\n LayoutVertical2ColumnsEntry,\n LayoutRendererEntry,\n FilterNumberControlRendererEntry,\n ConnectedMultiselectControlRendererEntry,\n EnumControlRendererEntry,\n ConnectedSelectControlRendererEntry,\n FilterDateControlRendererEntry,\n FilterTimeControlRendererEntry,\n InvisibleControlEntry,\n]",
1440
+ "description": "Allows to provide the main set of renderers used by the form. If not provided, the built-in renderers will be used by default.",
1441
+ "privacy": "public"
1512
1442
  },
1513
1443
  {
1514
1444
  "kind": "field",
1515
- "name": "renderers",
1445
+ "name": "jsonSchema",
1516
1446
  "type": {
1517
- "text": "JsonFormsRendererRegistryEntry[]"
1518
- }
1447
+ "text": "JSONSchema7"
1448
+ },
1449
+ "description": "Alternatively to providing Form.resourceName you can hardcode the JSON schema on the client.",
1450
+ "privacy": "public"
1519
1451
  },
1520
1452
  {
1521
- "kind": "method",
1522
- "name": "renderersChanged"
1453
+ "kind": "field",
1454
+ "name": "prefix",
1455
+ "type": {
1456
+ "text": "string"
1457
+ },
1458
+ "default": "'rapid'",
1459
+ "description": "Name of the design system prefix that will be used in renderers.",
1460
+ "privacy": "public"
1523
1461
  },
1524
1462
  {
1525
1463
  "kind": "field",
1526
- "name": "validationMode",
1464
+ "name": "connect",
1527
1465
  "type": {
1528
- "text": "ValidationMode"
1529
- }
1466
+ "text": "Connect"
1467
+ },
1468
+ "privacy": "private"
1530
1469
  },
1531
1470
  {
1532
- "kind": "method",
1533
- "name": "validationModeChanged"
1471
+ "kind": "field",
1472
+ "name": "data",
1473
+ "type": {
1474
+ "text": "any"
1475
+ },
1476
+ "default": "{}",
1477
+ "description": "Initial data for the filters.",
1478
+ "privacy": "public"
1534
1479
  },
1535
1480
  {
1536
1481
  "kind": "field",
1537
- "name": "ajv",
1482
+ "name": "value",
1538
1483
  "type": {
1539
- "text": "Ajv"
1540
- }
1484
+ "text": "string"
1485
+ },
1486
+ "description": "Created criteria based on the given data that can be used to filter the data.",
1487
+ "privacy": "public"
1541
1488
  },
1542
1489
  {
1543
1490
  "kind": "method",
1544
- "name": "ajvChanged"
1545
- },
1546
- {
1547
- "kind": "field",
1548
- "name": "readonly",
1549
- "type": {
1550
- "text": "boolean"
1551
- }
1491
+ "name": "saveFilter"
1552
1492
  },
1553
1493
  {
1554
1494
  "kind": "method",
1555
- "name": "readonlyChanged"
1495
+ "name": "deleteFilter"
1556
1496
  },
1557
1497
  {
1558
- "kind": "field",
1559
- "name": "config",
1560
- "type": {
1561
- "text": "any"
1562
- }
1498
+ "kind": "method",
1499
+ "name": "loadAllSavedFilters"
1563
1500
  },
1564
1501
  {
1565
1502
  "kind": "method",
1566
- "name": "configChanged"
1503
+ "name": "filterNameChanged",
1504
+ "parameters": [
1505
+ {
1506
+ "name": "oldValue",
1507
+ "type": {
1508
+ "text": "string"
1509
+ }
1510
+ },
1511
+ {
1512
+ "name": "newValue",
1513
+ "type": {
1514
+ "text": "string"
1515
+ }
1516
+ }
1517
+ ]
1567
1518
  },
1568
1519
  {
1569
- "kind": "field",
1570
- "name": "rowSubmitStatuses",
1571
- "type": {
1572
- "text": "Map<number, BulkRowStatus>"
1573
- },
1574
- "default": "new Map()",
1575
- "description": "Row submit statuses for bulk insert mode.\nPassed from the parent foundation-form."
1520
+ "kind": "method",
1521
+ "name": "loadFilterData",
1522
+ "parameters": [
1523
+ {
1524
+ "name": "filterKey",
1525
+ "type": {
1526
+ "text": "string"
1527
+ }
1528
+ }
1529
+ ]
1576
1530
  },
1577
1531
  {
1578
1532
  "kind": "method",
1579
- "name": "rowSubmitStatusesChanged"
1580
- },
1581
- {
1582
- "kind": "field",
1583
- "name": "bulkInsert",
1584
- "type": {
1585
- "text": "boolean"
1533
+ "name": "cloneNode",
1534
+ "return": {
1535
+ "type": {
1536
+ "text": "Node"
1537
+ }
1586
1538
  },
1587
- "default": "false",
1588
- "description": "Whether the form is in bulk insert mode.\nPassed from the parent foundation-form."
1539
+ "parameters": [
1540
+ {
1541
+ "name": "deep",
1542
+ "optional": true,
1543
+ "type": {
1544
+ "text": "boolean"
1545
+ }
1546
+ }
1547
+ ],
1548
+ "inheritedFrom": {
1549
+ "name": "LifecycleMixin",
1550
+ "module": "src/mixins/lifecycle/lifecycle.ts"
1551
+ }
1589
1552
  },
1590
1553
  {
1591
1554
  "kind": "method",
1592
- "name": "bulkInsertChanged"
1593
- },
1594
- {
1595
- "kind": "field",
1596
- "name": "props",
1597
- "type": {
1598
- "text": "RendererProps"
1555
+ "name": "deepClone",
1556
+ "return": {
1557
+ "type": {
1558
+ "text": "Node"
1559
+ }
1599
1560
  },
1600
- "readonly": true
1561
+ "inheritedFrom": {
1562
+ "name": "LifecycleMixin",
1563
+ "module": "src/mixins/lifecycle/lifecycle.ts"
1564
+ }
1601
1565
  },
1602
1566
  {
1603
1567
  "kind": "field",
1604
- "name": "dispatch"
1568
+ "name": "shouldRunDisconnect",
1569
+ "return": {
1570
+ "type": {
1571
+ "text": ""
1572
+ }
1573
+ },
1574
+ "readonly": true,
1575
+ "inheritedFrom": {
1576
+ "name": "LifecycleMixin",
1577
+ "module": "src/mixins/lifecycle/lifecycle.ts"
1578
+ }
1605
1579
  },
1606
1580
  {
1607
1581
  "kind": "field",
1608
- "name": "validate",
1609
- "description": "Performs client-side validation by running the validator defined in the UI schema.",
1610
- "parameters": [
1611
- {
1612
- "description": "the UI schema",
1613
- "name": "uischema"
1614
- },
1615
- {
1616
- "description": "the data to validate against (defaults to the current core data)",
1617
- "name": "data"
1618
- }
1619
- ],
1582
+ "name": "shouldRunConnect",
1620
1583
  "return": {
1621
1584
  "type": {
1622
1585
  "text": ""
1623
1586
  }
1587
+ },
1588
+ "readonly": true,
1589
+ "inheritedFrom": {
1590
+ "name": "LifecycleMixin",
1591
+ "module": "src/mixins/lifecycle/lifecycle.ts"
1624
1592
  }
1625
1593
  },
1626
1594
  {
1627
1595
  "kind": "method",
1628
- "name": "copyUISchemaToClipboard"
1629
- }
1630
- ],
1631
- "events": [
1632
- {
1633
- "description": "Bubbles from nested dispatch-renderer when a control emits change (e.g. multiselect)",
1634
- "name": "change"
1635
- },
1636
- {
1637
- "description": "Fired when bound form data changes",
1638
- "name": "data-change"
1639
- }
1640
- ],
1641
- "attributes": [
1642
- {
1643
- "type": {
1644
- "text": "boolean"
1645
- },
1646
- "fieldName": "readonly"
1647
- }
1648
- ],
1649
- "superclass": {
1650
- "name": "FASTElement",
1651
- "package": "@microsoft/fast-element"
1652
- },
1653
- "tagName": "json-forms",
1654
- "customElement": true
1655
- }
1656
- ],
1657
- "exports": [
1658
- {
1659
- "kind": "js",
1660
- "name": "JSONForms",
1661
- "declaration": {
1662
- "name": "JSONForms",
1663
- "module": "src/jsonforms/json-forms.ts"
1664
- }
1665
- },
1666
- {
1667
- "kind": "custom-element-definition",
1668
- "name": "json-forms",
1669
- "declaration": {
1670
- "name": "JSONForms",
1671
- "module": "src/jsonforms/json-forms.ts"
1672
- }
1673
- }
1674
- ]
1675
- },
1676
- {
1677
- "kind": "javascript-module",
1678
- "path": "src/utils/confirmation-dialog-utils.ts",
1679
- "declarations": [],
1680
- "exports": []
1681
- },
1682
- {
1683
- "kind": "javascript-module",
1684
- "path": "src/utils/csv-parser.ts",
1685
- "declarations": [
1686
- {
1687
- "kind": "function",
1688
- "name": "parseCsv",
1689
- "return": {
1690
- "type": {
1691
- "text": ""
1692
- }
1693
- },
1694
- "parameters": [
1695
- {
1696
- "name": "content",
1697
- "type": {
1698
- "text": "string"
1596
+ "name": "#_blockLifecycleDueToTokenChange",
1597
+ "return": {
1598
+ "type": {
1599
+ "text": "boolean"
1600
+ }
1699
1601
  },
1700
- "description": "The CSV content as a string"
1701
- }
1702
- ],
1703
- "description": "Parses a CSV string into headers and rows using PapaParse.\nHandles quoted fields, escaped quotes, empty values, and mixed line endings.",
1704
- "privacy": "public"
1705
- },
1706
- {
1707
- "kind": "function",
1708
- "name": "mapCsvToSchema",
1709
- "return": {
1710
- "type": {
1711
- "text": ""
1712
- }
1713
- },
1714
- "parameters": [
1602
+ "parameters": [
1603
+ {
1604
+ "name": "lifecycleType",
1605
+ "type": {
1606
+ "text": "Lifecycletype"
1607
+ }
1608
+ }
1609
+ ],
1610
+ "inheritedFrom": {
1611
+ "name": "LifecycleMixin",
1612
+ "module": "src/mixins/lifecycle/lifecycle.ts"
1613
+ }
1614
+ },
1715
1615
  {
1716
- "name": "csvRows",
1616
+ "kind": "field",
1617
+ "name": "_presentation",
1717
1618
  "type": {
1718
- "text": "Record<string, string>[]"
1619
+ "text": "ComponentPresentation | null | undefined"
1719
1620
  },
1720
- "description": "The parsed CSV rows"
1621
+ "privacy": "private",
1622
+ "default": "void 0",
1623
+ "inheritedFrom": {
1624
+ "name": "FoundationElement",
1625
+ "module": "src/foundation-element/foundation-element.ts"
1626
+ }
1721
1627
  },
1722
1628
  {
1723
- "name": "schema",
1629
+ "kind": "field",
1630
+ "name": "$presentation",
1724
1631
  "type": {
1725
- "text": "JSONSchema7 | undefined"
1632
+ "text": "ComponentPresentation | null"
1726
1633
  },
1727
- "description": "The JSON schema defining the fields"
1634
+ "privacy": "public",
1635
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
1636
+ "inheritedFrom": {
1637
+ "name": "FoundationElement",
1638
+ "module": "src/foundation-element/foundation-element.ts"
1639
+ }
1728
1640
  },
1729
1641
  {
1730
- "name": "uiSchema",
1731
- "optional": true,
1642
+ "kind": "field",
1643
+ "name": "template",
1732
1644
  "type": {
1733
- "text": "UiSchema"
1645
+ "text": "ElementViewTemplate | void | null"
1734
1646
  },
1735
- "description": "Optional UI schema to map labels to field names on import"
1736
- }
1737
- ],
1738
- "description": "Maps CSV rows to schema fields with case-insensitive matching.\nWhen uiSchema is provided, CSV headers can also match UI schema labels.\nConverts values to appropriate types based on schema definition.",
1739
- "privacy": "public"
1740
- },
1741
- {
1742
- "kind": "function",
1743
- "name": "generateCsvTemplate",
1744
- "return": {
1745
- "type": {
1746
- "text": ""
1747
- }
1748
- },
1749
- "parameters": [
1647
+ "privacy": "public",
1648
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
1649
+ "inheritedFrom": {
1650
+ "name": "FoundationElement",
1651
+ "module": "src/foundation-element/foundation-element.ts"
1652
+ }
1653
+ },
1750
1654
  {
1751
- "name": "schema",
1752
- "type": {
1753
- "text": "JSONSchema7 | undefined"
1655
+ "kind": "method",
1656
+ "name": "templateChanged",
1657
+ "privacy": "protected",
1658
+ "return": {
1659
+ "type": {
1660
+ "text": "void"
1661
+ }
1754
1662
  },
1755
- "description": "The JSON schema defining the fields"
1663
+ "inheritedFrom": {
1664
+ "name": "FoundationElement",
1665
+ "module": "src/foundation-element/foundation-element.ts"
1666
+ }
1756
1667
  },
1757
1668
  {
1758
- "name": "uiSchema",
1759
- "optional": true,
1669
+ "kind": "field",
1670
+ "name": "styles",
1760
1671
  "type": {
1761
- "text": "UiSchema"
1672
+ "text": "ElementStyles | void | null"
1762
1673
  },
1763
- "description": "Optional UI schema to determine field order and visibility"
1674
+ "privacy": "public",
1675
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
1676
+ "inheritedFrom": {
1677
+ "name": "FoundationElement",
1678
+ "module": "src/foundation-element/foundation-element.ts"
1679
+ }
1764
1680
  },
1765
1681
  {
1766
- "name": "includeOptionalFields",
1767
- "default": "true",
1768
- "type": {
1769
- "text": "boolean"
1682
+ "kind": "method",
1683
+ "name": "stylesChanged",
1684
+ "privacy": "protected",
1685
+ "return": {
1686
+ "type": {
1687
+ "text": "void"
1688
+ }
1770
1689
  },
1771
- "description": "Whether to include optional fields when no UI schema (default: true)"
1690
+ "inheritedFrom": {
1691
+ "name": "FoundationElement",
1692
+ "module": "src/foundation-element/foundation-element.ts"
1693
+ }
1772
1694
  },
1773
1695
  {
1774
- "name": "includeBom",
1775
- "default": "true",
1776
- "type": {
1777
- "text": "boolean"
1696
+ "kind": "method",
1697
+ "name": "compose",
1698
+ "privacy": "public",
1699
+ "static": true,
1700
+ "return": {
1701
+ "type": {
1702
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
1703
+ }
1778
1704
  },
1779
- "description": "Whether to prepend UTF-8 BOM for Excel compatibility (default: true)"
1705
+ "parameters": [
1706
+ {
1707
+ "name": "this",
1708
+ "type": {
1709
+ "text": "K"
1710
+ }
1711
+ },
1712
+ {
1713
+ "name": "elementDefinition",
1714
+ "type": {
1715
+ "text": "T"
1716
+ },
1717
+ "description": "The definition of the element to create the registry\nfunction for."
1718
+ }
1719
+ ],
1720
+ "description": "Defines an element registry function with a set of element definition defaults.",
1721
+ "inheritedFrom": {
1722
+ "name": "FoundationElement",
1723
+ "module": "src/foundation-element/foundation-element.ts"
1724
+ }
1780
1725
  }
1781
1726
  ],
1782
- "description": "Generates a CSV template string with headers and sample data based on JSON schema.\nIf a UI schema is provided, it will be used to determine which fields to include\nand in what order. Hidden fields in the UI schema will be excluded.",
1783
- "privacy": "public"
1784
- },
1785
- {
1786
- "kind": "function",
1787
- "name": "downloadCsvTemplate",
1788
- "return": {
1789
- "type": {
1790
- "text": "void"
1791
- }
1792
- },
1793
- "parameters": [
1727
+ "events": [
1794
1728
  {
1795
- "name": "csvContent",
1729
+ "name": "change",
1796
1730
  "type": {
1797
- "text": "string"
1731
+ "text": "CustomEvent"
1798
1732
  },
1799
- "description": "The CSV content to download"
1733
+ "description": "Fired when built criteria (`value`) updates"
1800
1734
  },
1801
1735
  {
1802
- "name": "fileName",
1803
- "default": "'template.csv'",
1736
+ "description": "Fired when filter values are submitted",
1737
+ "name": "submit"
1738
+ }
1739
+ ],
1740
+ "attributes": [
1741
+ {
1742
+ "name": "resourceName",
1804
1743
  "type": {
1805
1744
  "text": "string"
1806
1745
  },
1807
- "description": "The name for the downloaded file (default: 'template.csv')"
1808
- }
1809
- ],
1810
- "description": "Triggers a download of the CSV template file in the browser.",
1811
- "privacy": "public"
1812
- }
1813
- ],
1814
- "exports": [
1815
- {
1816
- "kind": "js",
1817
- "name": "parseCsv",
1818
- "declaration": {
1819
- "name": "parseCsv",
1820
- "module": "src/utils/csv-parser.ts"
1821
- }
1822
- },
1823
- {
1824
- "kind": "js",
1825
- "name": "mapCsvToSchema",
1826
- "declaration": {
1827
- "name": "mapCsvToSchema",
1828
- "module": "src/utils/csv-parser.ts"
1829
- }
1830
- },
1831
- {
1832
- "kind": "js",
1833
- "name": "generateCsvTemplate",
1834
- "declaration": {
1835
- "name": "generateCsvTemplate",
1836
- "module": "src/utils/csv-parser.ts"
1837
- }
1838
- },
1839
- {
1840
- "kind": "js",
1841
- "name": "downloadCsvTemplate",
1842
- "declaration": {
1843
- "name": "downloadCsvTemplate",
1844
- "module": "src/utils/csv-parser.ts"
1845
- }
1846
- }
1847
- ]
1848
- },
1849
- {
1850
- "kind": "javascript-module",
1851
- "path": "src/utils/filters.ts",
1852
- "declarations": [],
1853
- "exports": []
1854
- },
1855
- {
1856
- "kind": "javascript-module",
1857
- "path": "src/utils/form-utils.ts",
1858
- "declarations": [
1859
- {
1860
- "kind": "function",
1861
- "name": "removeDataPropertiesNotInSchema",
1862
- "return": {
1863
- "type": {
1864
- "text": ""
1865
- }
1866
- },
1867
- "parameters": [
1746
+ "description": "Name of the backend resource which will provide metadata\nused to generate filters.",
1747
+ "fieldName": "resourceName"
1748
+ },
1868
1749
  {
1869
- "name": "data",
1750
+ "name": "show-filter-persistence-controls",
1870
1751
  "type": {
1871
- "text": "any"
1752
+ "text": "boolean"
1872
1753
  },
1873
- "description": "The data object to clean"
1754
+ "description": "Controls the visibility of the filter persistence controls UI.",
1755
+ "fieldName": "showFilterPersistenceControls"
1874
1756
  },
1875
1757
  {
1876
- "name": "jsonSchema",
1758
+ "name": "design-system-prefix",
1877
1759
  "type": {
1878
- "text": "JSONSchema7"
1760
+ "text": "string"
1879
1761
  },
1880
- "description": "The JSON schema to validate against"
1762
+ "default": "'rapid'",
1763
+ "description": "Name of the design system prefix that will be used in renderers.",
1764
+ "fieldName": "prefix"
1881
1765
  }
1882
1766
  ],
1883
- "description": "Removes data properties that aren't part of the schema"
1767
+ "mixins": [
1768
+ {
1769
+ "name": "LifecycleMixin",
1770
+ "package": "@genesislcap/foundation-utils"
1771
+ }
1772
+ ],
1773
+ "superclass": {
1774
+ "name": "FoundationElement",
1775
+ "package": "@microsoft/fast-foundation"
1776
+ },
1777
+ "tagName": "foundation-filters",
1778
+ "customElement": true
1884
1779
  }
1885
1780
  ],
1886
1781
  "exports": [
1887
1782
  {
1888
1783
  "kind": "js",
1889
- "name": "removeDataPropertiesNotInSchema",
1890
- "declaration": {
1891
- "name": "removeDataPropertiesNotInSchema",
1892
- "module": "src/utils/form-utils.ts"
1893
- }
1894
- }
1895
- ]
1896
- },
1897
- {
1898
- "kind": "javascript-module",
1899
- "path": "src/utils/index.ts",
1900
- "declarations": [],
1901
- "exports": [
1902
- {
1903
- "kind": "js",
1904
- "name": "*",
1905
- "declaration": {
1906
- "name": "*",
1907
- "package": "./csv-parser"
1908
- }
1909
- },
1910
- {
1911
- "kind": "js",
1912
- "name": "*",
1913
- "declaration": {
1914
- "name": "*",
1915
- "package": "./filters"
1916
- }
1917
- },
1918
- {
1919
- "kind": "js",
1920
- "name": "*",
1921
- "declaration": {
1922
- "name": "*",
1923
- "package": "./logger"
1924
- }
1925
- },
1926
- {
1927
- "kind": "js",
1928
- "name": "*",
1784
+ "name": "filtersRenderers",
1929
1785
  "declaration": {
1930
- "name": "*",
1931
- "package": "./translation"
1786
+ "name": "filtersRenderers",
1787
+ "module": "src/filters/filters.ts"
1932
1788
  }
1933
1789
  },
1934
1790
  {
1935
1791
  "kind": "js",
1936
- "name": "*",
1792
+ "name": "Filters",
1937
1793
  "declaration": {
1938
- "name": "*",
1939
- "package": "./validation"
1794
+ "name": "Filters",
1795
+ "module": "src/filters/filters.ts"
1940
1796
  }
1941
1797
  },
1942
1798
  {
1943
- "kind": "js",
1944
- "name": "*",
1799
+ "kind": "custom-element-definition",
1800
+ "name": "foundation-filters",
1945
1801
  "declaration": {
1946
- "name": "*",
1947
- "package": "./types"
1802
+ "name": "Filters",
1803
+ "module": "src/filters/filters.ts"
1948
1804
  }
1949
- }
1950
- ]
1951
- },
1952
- {
1953
- "kind": "javascript-module",
1954
- "path": "src/utils/logger.ts",
1955
- "declarations": [],
1956
- "exports": []
1957
- },
1958
- {
1959
- "kind": "javascript-module",
1960
- "path": "src/utils/schema-utils.ts",
1961
- "declarations": [],
1962
- "exports": []
1963
- },
1964
- {
1965
- "kind": "javascript-module",
1966
- "path": "src/utils/translation.ts",
1967
- "declarations": [],
1968
- "exports": []
1805
+ }
1806
+ ]
1969
1807
  },
1970
1808
  {
1971
1809
  "kind": "javascript-module",
1972
- "path": "src/utils/types.ts",
1810
+ "path": "src/filters/index.ts",
1973
1811
  "declarations": [],
1974
- "exports": []
1812
+ "exports": [
1813
+ {
1814
+ "kind": "js",
1815
+ "name": "*",
1816
+ "declaration": {
1817
+ "name": "*",
1818
+ "package": "./filters"
1819
+ }
1820
+ }
1821
+ ]
1975
1822
  },
1976
1823
  {
1977
1824
  "kind": "javascript-module",
1978
- "path": "src/utils/validation.ts",
1825
+ "path": "src/jsonforms/json-forms.ts",
1979
1826
  "declarations": [
1980
1827
  {
1981
- "kind": "function",
1982
- "name": "mustMatch",
1983
- "parameters": [
1828
+ "kind": "class",
1829
+ "description": "JSON Forms host element for schema-driven UI.",
1830
+ "name": "JSONForms",
1831
+ "members": [
1984
1832
  {
1985
- "name": "target",
1833
+ "kind": "field",
1834
+ "name": "_submitted",
1986
1835
  "type": {
1987
- "text": "string"
1836
+ "text": "boolean"
1988
1837
  },
1989
- "description": "any other field"
1990
- }
1991
- ],
1992
- "description": "Ensures the value of the current field (the one the validator is on) matches the one of the target field.",
1993
- "return": {
1994
- "type": {
1995
- "text": ""
1996
- }
1997
- },
1998
- "privacy": "public"
1999
- },
2000
- {
2001
- "kind": "function",
2002
- "name": "getAnyOfErrorMessage",
2003
- "return": {
2004
- "type": {
2005
- "text": "string"
2006
- }
2007
- },
2008
- "parameters": [
1838
+ "privacy": "private",
1839
+ "default": "false"
1840
+ },
2009
1841
  {
2010
- "name": "errors",
1842
+ "kind": "field",
1843
+ "name": "submitted",
2011
1844
  "type": {
2012
- "text": "Array<any> | undefined"
1845
+ "text": "boolean"
2013
1846
  }
2014
1847
  },
2015
1848
  {
2016
- "name": "schema",
1849
+ "kind": "field",
1850
+ "name": "prefix"
1851
+ },
1852
+ {
1853
+ "kind": "method",
1854
+ "name": "prefixChanged"
1855
+ },
1856
+ {
1857
+ "kind": "field",
1858
+ "name": "jsonforms"
1859
+ },
1860
+ {
1861
+ "kind": "field",
1862
+ "name": "i18n"
1863
+ },
1864
+ {
1865
+ "kind": "field",
1866
+ "name": "uichemaToUse"
1867
+ },
1868
+ {
1869
+ "kind": "field",
1870
+ "name": "schema"
1871
+ },
1872
+ {
1873
+ "kind": "method",
1874
+ "name": "schemaChanged"
1875
+ },
1876
+ {
1877
+ "kind": "field",
1878
+ "name": "uischema",
2017
1879
  "type": {
2018
- "text": "any"
1880
+ "text": "UISchemaElement"
2019
1881
  }
2020
1882
  },
2021
1883
  {
2022
- "name": "controlPath",
1884
+ "kind": "method",
1885
+ "name": "uischemaChanged"
1886
+ },
1887
+ {
1888
+ "kind": "field",
1889
+ "name": "data"
1890
+ },
1891
+ {
1892
+ "kind": "method",
1893
+ "name": "dataChanged"
1894
+ },
1895
+ {
1896
+ "kind": "field",
1897
+ "name": "renderers",
2023
1898
  "type": {
2024
- "text": "string | undefined"
1899
+ "text": "JsonFormsRendererRegistryEntry[]"
2025
1900
  }
2026
1901
  },
2027
1902
  {
2028
- "name": "uiCustomMsg",
2029
- "optional": true,
1903
+ "kind": "method",
1904
+ "name": "renderersChanged"
1905
+ },
1906
+ {
1907
+ "kind": "field",
1908
+ "name": "validationMode",
2030
1909
  "type": {
2031
- "text": "string"
1910
+ "text": "ValidationMode"
1911
+ }
1912
+ },
1913
+ {
1914
+ "kind": "method",
1915
+ "name": "validationModeChanged"
1916
+ },
1917
+ {
1918
+ "kind": "field",
1919
+ "name": "ajv",
1920
+ "type": {
1921
+ "text": "Ajv"
2032
1922
  }
1923
+ },
1924
+ {
1925
+ "kind": "method",
1926
+ "name": "ajvChanged"
1927
+ },
1928
+ {
1929
+ "kind": "field",
1930
+ "name": "readonly",
1931
+ "type": {
1932
+ "text": "boolean"
1933
+ }
1934
+ },
1935
+ {
1936
+ "kind": "method",
1937
+ "name": "readonlyChanged"
1938
+ },
1939
+ {
1940
+ "kind": "field",
1941
+ "name": "config",
1942
+ "type": {
1943
+ "text": "any"
1944
+ }
1945
+ },
1946
+ {
1947
+ "kind": "method",
1948
+ "name": "configChanged"
1949
+ },
1950
+ {
1951
+ "kind": "field",
1952
+ "name": "rowSubmitStatuses",
1953
+ "type": {
1954
+ "text": "Map<number, BulkRowStatus>"
1955
+ },
1956
+ "default": "new Map()",
1957
+ "description": "Row submit statuses for bulk insert mode.\nPassed from the parent foundation-form."
1958
+ },
1959
+ {
1960
+ "kind": "method",
1961
+ "name": "rowSubmitStatusesChanged"
1962
+ },
1963
+ {
1964
+ "kind": "field",
1965
+ "name": "bulkInsert",
1966
+ "type": {
1967
+ "text": "boolean"
1968
+ },
1969
+ "default": "false",
1970
+ "description": "Whether the form is in bulk insert mode.\nPassed from the parent foundation-form."
1971
+ },
1972
+ {
1973
+ "kind": "method",
1974
+ "name": "bulkInsertChanged"
1975
+ },
1976
+ {
1977
+ "kind": "field",
1978
+ "name": "props",
1979
+ "type": {
1980
+ "text": "RendererProps"
1981
+ },
1982
+ "readonly": true
1983
+ },
1984
+ {
1985
+ "kind": "field",
1986
+ "name": "dispatch"
1987
+ },
1988
+ {
1989
+ "kind": "field",
1990
+ "name": "validate",
1991
+ "description": "Performs client-side validation by running the validator defined in the UI schema.",
1992
+ "parameters": [
1993
+ {
1994
+ "description": "the UI schema",
1995
+ "name": "uischema"
1996
+ },
1997
+ {
1998
+ "description": "the data to validate against (defaults to the current core data)",
1999
+ "name": "data"
2000
+ }
2001
+ ],
2002
+ "return": {
2003
+ "type": {
2004
+ "text": ""
2005
+ }
2006
+ }
2007
+ },
2008
+ {
2009
+ "kind": "method",
2010
+ "name": "copyUISchemaToClipboard"
2033
2011
  }
2034
2012
  ],
2035
- "description": "Computes a human-friendly anyOf error message for a given control path.\nPrefers UI schema custom message, then JSON schema errorMessage.anyOf, then a constructed fallback.",
2036
- "privacy": "public"
2013
+ "events": [
2014
+ {
2015
+ "description": "Bubbles from nested dispatch-renderer when a control emits change (e.g. multiselect)",
2016
+ "name": "change"
2017
+ },
2018
+ {
2019
+ "description": "Fired when bound form data changes",
2020
+ "name": "data-change"
2021
+ }
2022
+ ],
2023
+ "attributes": [
2024
+ {
2025
+ "type": {
2026
+ "text": "boolean"
2027
+ },
2028
+ "fieldName": "readonly"
2029
+ }
2030
+ ],
2031
+ "superclass": {
2032
+ "name": "FASTElement",
2033
+ "package": "@microsoft/fast-element"
2034
+ },
2035
+ "tagName": "json-forms",
2036
+ "customElement": true
2037
2037
  }
2038
2038
  ],
2039
2039
  "exports": [
2040
2040
  {
2041
2041
  "kind": "js",
2042
- "name": "mustMatch",
2042
+ "name": "JSONForms",
2043
2043
  "declaration": {
2044
- "name": "mustMatch",
2045
- "module": "src/utils/validation.ts"
2044
+ "name": "JSONForms",
2045
+ "module": "src/jsonforms/json-forms.ts"
2046
2046
  }
2047
2047
  },
2048
2048
  {
2049
- "kind": "js",
2050
- "name": "getAnyOfErrorMessage",
2049
+ "kind": "custom-element-definition",
2050
+ "name": "json-forms",
2051
2051
  "declaration": {
2052
- "name": "getAnyOfErrorMessage",
2053
- "module": "src/utils/validation.ts"
2052
+ "name": "JSONForms",
2053
+ "module": "src/jsonforms/json-forms.ts"
2054
2054
  }
2055
2055
  }
2056
2056
  ]