@cloudcannon/configuration-types 0.0.4 → 0.0.6

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.
@@ -121,8 +121,6 @@
121
121
  },
122
122
  "type": {
123
123
  "const": "array",
124
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
125
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
126
124
  "type": "string"
127
125
  }
128
126
  },
@@ -231,9 +229,14 @@
231
229
  "markdownDescription": "Options that are specific to this `type` of input."
232
230
  },
233
231
  "type": {
234
- "$ref": "#/definitions/InputType",
235
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
236
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with."
232
+ "anyOf": [
233
+ {
234
+ "$ref": "#/definitions/InputType"
235
+ },
236
+ {
237
+ "type": "null"
238
+ }
239
+ ]
237
240
  }
238
241
  },
239
242
  "type": "object"
@@ -426,27 +429,28 @@
426
429
  "type": "string"
427
430
  },
428
431
  "sizes": {
429
- "additionalProperties": false,
430
432
  "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
431
- "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
432
- "properties": {
433
- "size": {
434
- "const": "string",
435
- "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
436
- "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
437
- "type": "string"
433
+ "items": {
434
+ "additionalProperties": false,
435
+ "properties": {
436
+ "size": {
437
+ "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
438
+ "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
439
+ "type": "string"
440
+ },
441
+ "target": {
442
+ "description": "A reference to another input that is given the path to this additional image file.",
443
+ "markdownDescription": "A reference to another input that is given the path to this additional image file.",
444
+ "type": "string"
445
+ }
438
446
  },
439
- "target": {
440
- "const": "string",
441
- "description": "A reference to another input that is given the path to this additional image file.",
442
- "markdownDescription": "A reference to another input that is given the path to this additional image file.",
443
- "type": "string"
444
- }
447
+ "required": [
448
+ "size"
449
+ ],
450
+ "type": "object"
445
451
  },
446
- "required": [
447
- "size"
448
- ],
449
- "type": "object"
452
+ "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
453
+ "type": "array"
450
454
  },
451
455
  "snippet": {
452
456
  "description": "Enables a control to insert snippets, if any are available.",
@@ -569,8 +573,6 @@
569
573
  },
570
574
  "type": {
571
575
  "const": "choice",
572
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
573
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
574
576
  "type": "string"
575
577
  }
576
578
  },
@@ -684,8 +686,6 @@
684
686
  },
685
687
  "type": {
686
688
  "const": "code",
687
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
688
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
689
689
  "type": "string"
690
690
  }
691
691
  },
@@ -836,8 +836,6 @@
836
836
  },
837
837
  "type": {
838
838
  "const": "color",
839
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
840
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
841
839
  "type": "string"
842
840
  }
843
841
  },
@@ -1033,12 +1031,10 @@
1033
1031
  "markdownDescription": "Options that are specific to this `type` of input."
1034
1032
  },
1035
1033
  "type": {
1036
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
1037
1034
  "enum": [
1038
1035
  "date",
1039
1036
  "datetime"
1040
1037
  ],
1041
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
1042
1038
  "type": "string"
1043
1039
  }
1044
1040
  },
@@ -1198,82 +1194,7 @@
1198
1194
  },
1199
1195
  "_snippets": {
1200
1196
  "additionalProperties": {
1201
- "additionalProperties": false,
1202
- "properties": {
1203
- "_inputs": {
1204
- "additionalProperties": {
1205
- "$ref": "#/definitions/Input"
1206
- },
1207
- "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1208
- "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1209
- "type": "object"
1210
- },
1211
- "_select_data": {
1212
- "additionalProperties": {
1213
- "$ref": "#/definitions/SelectValues"
1214
- },
1215
- "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1216
- "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1217
- "type": "object"
1218
- },
1219
- "_structures": {
1220
- "additionalProperties": {
1221
- "$ref": "#/definitions/Structure"
1222
- },
1223
- "description": "Structured values for editors adding new items to arrays and objects. Entries here can be referenced in the configuration for `array` or `object` inputs.",
1224
- "markdownDescription": "Structured values for editors adding new items to arrays and objects. Entries here can be\nreferenced in the configuration for `array` or `object` inputs.",
1225
- "type": "object"
1226
- },
1227
- "alternate_formats": {
1228
- "description": "Alternate configurations for this snippet.",
1229
- "items": {
1230
- "$ref": "#/definitions/interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487"
1231
- },
1232
- "markdownDescription": "Alternate configurations for this snippet.",
1233
- "type": "array"
1234
- },
1235
- "definitions": {
1236
- "description": "The variables required for the selected template.",
1237
- "markdownDescription": "The variables required for the selected template.",
1238
- "type": "object"
1239
- },
1240
- "inline": {
1241
- "description": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat this snippet as a block-level element in the content editor.",
1242
- "markdownDescription": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat\nthis snippet as a block-level element in the content editor.",
1243
- "type": "boolean"
1244
- },
1245
- "params": {
1246
- "description": "The parameters of this snippet.",
1247
- "markdownDescription": "The parameters of this snippet.",
1248
- "type": "object"
1249
- },
1250
- "picker_preview": {
1251
- "$ref": "#/definitions/Preview",
1252
- "description": "Changes the way items are previewed in the CMS while being chosen.",
1253
- "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
1254
- },
1255
- "preview": {
1256
- "$ref": "#/definitions/Preview",
1257
- "description": "Changes the way items are previewed in the CMS.",
1258
- "markdownDescription": "Changes the way items are previewed in the CMS."
1259
- },
1260
- "snippet": {
1261
- "description": "Name of the snippet.",
1262
- "markdownDescription": "Name of the snippet.",
1263
- "type": "string"
1264
- },
1265
- "strict_whitespace": {
1266
- "description": "Whether this snippet treats whitespace as-is or not.",
1267
- "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
1268
- "type": "boolean"
1269
- },
1270
- "template": {
1271
- "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1272
- "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1273
- "type": "string"
1274
- }
1275
- },
1276
- "type": "object"
1197
+ "$ref": "#/definitions/SnippetConfig"
1277
1198
  },
1278
1199
  "description": "Configuration for custom snippets.",
1279
1200
  "markdownDescription": "Configuration for custom snippets.",
@@ -1281,82 +1202,7 @@
1281
1202
  },
1282
1203
  "_snippets_definitions": {
1283
1204
  "additionalProperties": {
1284
- "additionalProperties": false,
1285
- "properties": {
1286
- "_inputs": {
1287
- "additionalProperties": {
1288
- "$ref": "#/definitions/Input"
1289
- },
1290
- "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1291
- "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1292
- "type": "object"
1293
- },
1294
- "_select_data": {
1295
- "additionalProperties": {
1296
- "$ref": "#/definitions/SelectValues"
1297
- },
1298
- "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1299
- "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1300
- "type": "object"
1301
- },
1302
- "_structures": {
1303
- "additionalProperties": {
1304
- "$ref": "#/definitions/Structure"
1305
- },
1306
- "description": "Structured values for editors adding new items to arrays and objects. Entries here can be referenced in the configuration for `array` or `object` inputs.",
1307
- "markdownDescription": "Structured values for editors adding new items to arrays and objects. Entries here can be\nreferenced in the configuration for `array` or `object` inputs.",
1308
- "type": "object"
1309
- },
1310
- "alternate_formats": {
1311
- "description": "Alternate configurations for this snippet.",
1312
- "items": {
1313
- "$ref": "#/definitions/interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487"
1314
- },
1315
- "markdownDescription": "Alternate configurations for this snippet.",
1316
- "type": "array"
1317
- },
1318
- "definitions": {
1319
- "description": "The variables required for the selected template.",
1320
- "markdownDescription": "The variables required for the selected template.",
1321
- "type": "object"
1322
- },
1323
- "inline": {
1324
- "description": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat this snippet as a block-level element in the content editor.",
1325
- "markdownDescription": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat\nthis snippet as a block-level element in the content editor.",
1326
- "type": "boolean"
1327
- },
1328
- "params": {
1329
- "description": "The parameters of this snippet.",
1330
- "markdownDescription": "The parameters of this snippet.",
1331
- "type": "object"
1332
- },
1333
- "picker_preview": {
1334
- "$ref": "#/definitions/Preview",
1335
- "description": "Changes the way items are previewed in the CMS while being chosen.",
1336
- "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
1337
- },
1338
- "preview": {
1339
- "$ref": "#/definitions/Preview",
1340
- "description": "Changes the way items are previewed in the CMS.",
1341
- "markdownDescription": "Changes the way items are previewed in the CMS."
1342
- },
1343
- "snippet": {
1344
- "description": "Name of the snippet.",
1345
- "markdownDescription": "Name of the snippet.",
1346
- "type": "string"
1347
- },
1348
- "strict_whitespace": {
1349
- "description": "Whether this snippet treats whitespace as-is or not.",
1350
- "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
1351
- "type": "boolean"
1352
- },
1353
- "template": {
1354
- "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1355
- "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1356
- "type": "string"
1357
- }
1358
- },
1359
- "type": "object"
1205
+ "$ref": "#/definitions/SnippetConfig"
1360
1206
  },
1361
1207
  "description": "Extended option used when creating more complex custom snippets.",
1362
1208
  "markdownDescription": "Extended option used when creating more complex custom snippets.",
@@ -1369,82 +1215,7 @@
1369
1215
  },
1370
1216
  "_snippets_templates": {
1371
1217
  "additionalProperties": {
1372
- "additionalProperties": false,
1373
- "properties": {
1374
- "_inputs": {
1375
- "additionalProperties": {
1376
- "$ref": "#/definitions/Input"
1377
- },
1378
- "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1379
- "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1380
- "type": "object"
1381
- },
1382
- "_select_data": {
1383
- "additionalProperties": {
1384
- "$ref": "#/definitions/SelectValues"
1385
- },
1386
- "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1387
- "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1388
- "type": "object"
1389
- },
1390
- "_structures": {
1391
- "additionalProperties": {
1392
- "$ref": "#/definitions/Structure"
1393
- },
1394
- "description": "Structured values for editors adding new items to arrays and objects. Entries here can be referenced in the configuration for `array` or `object` inputs.",
1395
- "markdownDescription": "Structured values for editors adding new items to arrays and objects. Entries here can be\nreferenced in the configuration for `array` or `object` inputs.",
1396
- "type": "object"
1397
- },
1398
- "alternate_formats": {
1399
- "description": "Alternate configurations for this snippet.",
1400
- "items": {
1401
- "$ref": "#/definitions/interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487"
1402
- },
1403
- "markdownDescription": "Alternate configurations for this snippet.",
1404
- "type": "array"
1405
- },
1406
- "definitions": {
1407
- "description": "The variables required for the selected template.",
1408
- "markdownDescription": "The variables required for the selected template.",
1409
- "type": "object"
1410
- },
1411
- "inline": {
1412
- "description": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat this snippet as a block-level element in the content editor.",
1413
- "markdownDescription": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat\nthis snippet as a block-level element in the content editor.",
1414
- "type": "boolean"
1415
- },
1416
- "params": {
1417
- "description": "The parameters of this snippet.",
1418
- "markdownDescription": "The parameters of this snippet.",
1419
- "type": "object"
1420
- },
1421
- "picker_preview": {
1422
- "$ref": "#/definitions/Preview",
1423
- "description": "Changes the way items are previewed in the CMS while being chosen.",
1424
- "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
1425
- },
1426
- "preview": {
1427
- "$ref": "#/definitions/Preview",
1428
- "description": "Changes the way items are previewed in the CMS.",
1429
- "markdownDescription": "Changes the way items are previewed in the CMS."
1430
- },
1431
- "snippet": {
1432
- "description": "Name of the snippet.",
1433
- "markdownDescription": "Name of the snippet.",
1434
- "type": "string"
1435
- },
1436
- "strict_whitespace": {
1437
- "description": "Whether this snippet treats whitespace as-is or not.",
1438
- "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
1439
- "type": "boolean"
1440
- },
1441
- "template": {
1442
- "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1443
- "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1444
- "type": "string"
1445
- }
1446
- },
1447
- "type": "object"
1218
+ "$ref": "#/definitions/SnippetConfig"
1448
1219
  },
1449
1220
  "description": "Extended option used when creating more complex custom snippets.",
1450
1221
  "markdownDescription": "Extended option used when creating more complex custom snippets.",
@@ -1866,12 +1637,10 @@
1866
1637
  "markdownDescription": "Options that are specific to this `type` of input."
1867
1638
  },
1868
1639
  "type": {
1869
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
1870
1640
  "enum": [
1871
1641
  "file",
1872
1642
  "document"
1873
1643
  ],
1874
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
1875
1644
  "type": "string"
1876
1645
  }
1877
1646
  },
@@ -1899,6 +1668,14 @@
1899
1668
  "description": "Restricts which file types are available to select or upload to this input.",
1900
1669
  "markdownDescription": "Restricts which file types are available to select or upload to this input."
1901
1670
  },
1671
+ "allowed_sources": {
1672
+ "description": "If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.",
1673
+ "items": {
1674
+ "type": "string"
1675
+ },
1676
+ "markdownDescription": "If you have one or more DAMs connected to your site, you can use this key to list which asset\nsources can be uploaded to and selected from.",
1677
+ "type": "array"
1678
+ },
1902
1679
  "empty_type": {
1903
1680
  "$ref": "#/definitions/EmptyTypeText",
1904
1681
  "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
@@ -4142,27 +3919,28 @@
4142
3919
  "type": "string"
4143
3920
  },
4144
3921
  "sizes": {
4145
- "additionalProperties": false,
4146
3922
  "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
4147
- "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
4148
- "properties": {
4149
- "size": {
4150
- "const": "string",
4151
- "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
4152
- "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
4153
- "type": "string"
3923
+ "items": {
3924
+ "additionalProperties": false,
3925
+ "properties": {
3926
+ "size": {
3927
+ "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
3928
+ "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
3929
+ "type": "string"
3930
+ },
3931
+ "target": {
3932
+ "description": "A reference to another input that is given the path to this additional image file.",
3933
+ "markdownDescription": "A reference to another input that is given the path to this additional image file.",
3934
+ "type": "string"
3935
+ }
4154
3936
  },
4155
- "target": {
4156
- "const": "string",
4157
- "description": "A reference to another input that is given the path to this additional image file.",
4158
- "markdownDescription": "A reference to another input that is given the path to this additional image file.",
4159
- "type": "string"
4160
- }
3937
+ "required": [
3938
+ "size"
3939
+ ],
3940
+ "type": "object"
4161
3941
  },
4162
- "required": [
4163
- "size"
4164
- ],
4165
- "type": "object"
3942
+ "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
3943
+ "type": "array"
4166
3944
  },
4167
3945
  "width": {
4168
3946
  "description": "Defines the width of the bounding box used in the image resizing process defined with resize_style.",
@@ -4245,8 +4023,6 @@
4245
4023
  },
4246
4024
  "type": {
4247
4025
  "const": "image",
4248
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
4249
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
4250
4026
  "type": "string"
4251
4027
  }
4252
4028
  },
@@ -4343,27 +4119,28 @@
4343
4119
  "type": "string"
4344
4120
  },
4345
4121
  "sizes": {
4346
- "additionalProperties": false,
4347
4122
  "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
4348
- "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
4349
- "properties": {
4350
- "size": {
4351
- "const": "string",
4352
- "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
4353
- "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
4354
- "type": "string"
4123
+ "items": {
4124
+ "additionalProperties": false,
4125
+ "properties": {
4126
+ "size": {
4127
+ "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
4128
+ "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
4129
+ "type": "string"
4130
+ },
4131
+ "target": {
4132
+ "description": "A reference to another input that is given the path to this additional image file.",
4133
+ "markdownDescription": "A reference to another input that is given the path to this additional image file.",
4134
+ "type": "string"
4135
+ }
4355
4136
  },
4356
- "target": {
4357
- "const": "string",
4358
- "description": "A reference to another input that is given the path to this additional image file.",
4359
- "markdownDescription": "A reference to another input that is given the path to this additional image file.",
4360
- "type": "string"
4361
- }
4137
+ "required": [
4138
+ "size"
4139
+ ],
4140
+ "type": "object"
4362
4141
  },
4363
- "required": [
4364
- "size"
4365
- ],
4366
- "type": "object"
4142
+ "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
4143
+ "type": "array"
4367
4144
  },
4368
4145
  "width": {
4369
4146
  "description": "Defines the width of the bounding box used in the image resizing process defined with resize_style.",
@@ -4378,6 +4155,9 @@
4378
4155
  {
4379
4156
  "$ref": "#/definitions/BaseInput"
4380
4157
  },
4158
+ {
4159
+ "$ref": "#/definitions/UnknownInput"
4160
+ },
4381
4161
  {
4382
4162
  "$ref": "#/definitions/TextInput"
4383
4163
  },
@@ -4992,8 +4772,6 @@
4992
4772
  },
4993
4773
  "type": {
4994
4774
  "const": "multichoice",
4995
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
4996
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
4997
4775
  "type": "string"
4998
4776
  }
4999
4777
  },
@@ -5107,8 +4885,6 @@
5107
4885
  },
5108
4886
  "type": {
5109
4887
  "const": "multiselect",
5110
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
5111
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
5112
4888
  "type": "string"
5113
4889
  }
5114
4890
  },
@@ -5223,8 +4999,6 @@
5223
4999
  },
5224
5000
  "type": {
5225
5001
  "const": "number",
5226
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
5227
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
5228
5002
  "type": "string"
5229
5003
  }
5230
5004
  },
@@ -5332,8 +5106,6 @@
5332
5106
  },
5333
5107
  "type": {
5334
5108
  "const": "object",
5335
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
5336
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
5337
5109
  "type": "string"
5338
5110
  }
5339
5111
  },
@@ -5342,9 +5114,38 @@
5342
5114
  ],
5343
5115
  "type": "object"
5344
5116
  },
5117
+ "ObjectInputGroup": {
5118
+ "additionalProperties": false,
5119
+ "properties": {
5120
+ "collapsed": {
5121
+ "type": "boolean"
5122
+ },
5123
+ "comment": {
5124
+ "type": "string"
5125
+ },
5126
+ "documentation": {
5127
+ "$ref": "#/definitions/Documentation"
5128
+ },
5129
+ "heading": {
5130
+ "type": "string"
5131
+ },
5132
+ "inputs": {
5133
+ "items": {
5134
+ "type": "string"
5135
+ },
5136
+ "type": "array"
5137
+ }
5138
+ },
5139
+ "type": "object"
5140
+ },
5345
5141
  "ObjectInputOptions": {
5346
5142
  "additionalProperties": false,
5347
5143
  "properties": {
5144
+ "allow_label_formatting": {
5145
+ "description": "Controls whether or not labels on mutable object entries are formatted.",
5146
+ "markdownDescription": "Controls whether or not labels on mutable object entries are formatted.",
5147
+ "type": "boolean"
5148
+ },
5348
5149
  "empty_type": {
5349
5150
  "$ref": "#/definitions/EmptyTypeObject",
5350
5151
  "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
@@ -5389,6 +5190,19 @@
5389
5190
  },
5390
5191
  "type": "object"
5391
5192
  },
5193
+ "groups": {
5194
+ "description": "Allows you to group the inputs inside this object together without changing the data structure.",
5195
+ "items": {
5196
+ "$ref": "#/definitions/ObjectInputGroup"
5197
+ },
5198
+ "markdownDescription": "Allows you to group the inputs inside this object together without changing the data structure.",
5199
+ "type": "array"
5200
+ },
5201
+ "place_groups_below": {
5202
+ "description": "Controls which order input groups and ungrouped inputs appear in.",
5203
+ "markdownDescription": "Controls which order input groups and ungrouped inputs appear in.",
5204
+ "type": "boolean"
5205
+ },
5392
5206
  "preview": {
5393
5207
  "$ref": "#/definitions/ObjectPreview",
5394
5208
  "description": "The preview definition for changing the way data within an object input is previewed before being expanded. If the input has `structures`, the preview from the structure value is used instead.",
@@ -5636,6 +5450,11 @@
5636
5450
  "description": "Filename template for newly uploaded site files.",
5637
5451
  "markdownDescription": "Filename template for newly uploaded site files.",
5638
5452
  "type": "string"
5453
+ },
5454
+ "uploads_use_relative_path": {
5455
+ "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
5456
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
5457
+ "type": "boolean"
5639
5458
  }
5640
5459
  },
5641
5460
  "type": "object"
@@ -6160,8 +5979,6 @@
6160
5979
  },
6161
5980
  "type": {
6162
5981
  "const": "range",
6163
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
6164
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
6165
5982
  "type": "string"
6166
5983
  }
6167
5984
  },
@@ -6236,6 +6053,11 @@
6236
6053
  "description": "Filename template for newly uploaded site files.",
6237
6054
  "markdownDescription": "Filename template for newly uploaded site files.",
6238
6055
  "type": "string"
6056
+ },
6057
+ "uploads_use_relative_path": {
6058
+ "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
6059
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
6060
+ "type": "boolean"
6239
6061
  }
6240
6062
  },
6241
6063
  "type": "object"
@@ -6312,12 +6134,10 @@
6312
6134
  "markdownDescription": "Options that are specific to this `type` of input."
6313
6135
  },
6314
6136
  "type": {
6315
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
6316
6137
  "enum": [
6317
6138
  "html",
6318
6139
  "markdown"
6319
6140
  ],
6320
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
6321
6141
  "type": "string"
6322
6142
  }
6323
6143
  },
@@ -6518,27 +6338,28 @@
6518
6338
  "type": "string"
6519
6339
  },
6520
6340
  "sizes": {
6521
- "additionalProperties": false,
6522
6341
  "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
6523
- "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
6524
- "properties": {
6525
- "size": {
6526
- "const": "string",
6527
- "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
6528
- "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
6529
- "type": "string"
6342
+ "items": {
6343
+ "additionalProperties": false,
6344
+ "properties": {
6345
+ "size": {
6346
+ "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
6347
+ "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
6348
+ "type": "string"
6349
+ },
6350
+ "target": {
6351
+ "description": "A reference to another input that is given the path to this additional image file.",
6352
+ "markdownDescription": "A reference to another input that is given the path to this additional image file.",
6353
+ "type": "string"
6354
+ }
6530
6355
  },
6531
- "target": {
6532
- "const": "string",
6533
- "description": "A reference to another input that is given the path to this additional image file.",
6534
- "markdownDescription": "A reference to another input that is given the path to this additional image file.",
6535
- "type": "string"
6536
- }
6356
+ "required": [
6357
+ "size"
6358
+ ],
6359
+ "type": "object"
6537
6360
  },
6538
- "required": [
6539
- "size"
6540
- ],
6541
- "type": "object"
6361
+ "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
6362
+ "type": "array"
6542
6363
  },
6543
6364
  "snippet": {
6544
6365
  "description": "Enables a control to insert snippets, if any are available.",
@@ -6785,8 +6606,6 @@
6785
6606
  },
6786
6607
  "type": {
6787
6608
  "const": "select",
6788
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
6789
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
6790
6609
  "type": "string"
6791
6610
  }
6792
6611
  },
@@ -6937,6 +6756,84 @@
6937
6756
  }
6938
6757
  ]
6939
6758
  },
6759
+ "SnippetConfig": {
6760
+ "additionalProperties": false,
6761
+ "properties": {
6762
+ "_inputs": {
6763
+ "additionalProperties": {
6764
+ "$ref": "#/definitions/Input"
6765
+ },
6766
+ "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
6767
+ "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
6768
+ "type": "object"
6769
+ },
6770
+ "_select_data": {
6771
+ "additionalProperties": {
6772
+ "$ref": "#/definitions/SelectValues"
6773
+ },
6774
+ "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
6775
+ "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
6776
+ "type": "object"
6777
+ },
6778
+ "_structures": {
6779
+ "additionalProperties": {
6780
+ "$ref": "#/definitions/Structure"
6781
+ },
6782
+ "description": "Structured values for editors adding new items to arrays and objects. Entries here can be referenced in the configuration for `array` or `object` inputs.",
6783
+ "markdownDescription": "Structured values for editors adding new items to arrays and objects. Entries here can be\nreferenced in the configuration for `array` or `object` inputs.",
6784
+ "type": "object"
6785
+ },
6786
+ "alternate_formats": {
6787
+ "description": "Alternate configurations for this snippet.",
6788
+ "items": {
6789
+ "$ref": "#/definitions/SnippetConfig"
6790
+ },
6791
+ "markdownDescription": "Alternate configurations for this snippet.",
6792
+ "type": "array"
6793
+ },
6794
+ "definitions": {
6795
+ "description": "The variables required for the selected template.",
6796
+ "markdownDescription": "The variables required for the selected template.",
6797
+ "type": "object"
6798
+ },
6799
+ "inline": {
6800
+ "description": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat this snippet as a block-level element in the content editor.",
6801
+ "markdownDescription": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat\nthis snippet as a block-level element in the content editor.",
6802
+ "type": "boolean"
6803
+ },
6804
+ "params": {
6805
+ "description": "The parameters of this snippet.",
6806
+ "markdownDescription": "The parameters of this snippet.",
6807
+ "type": "object"
6808
+ },
6809
+ "picker_preview": {
6810
+ "$ref": "#/definitions/Preview",
6811
+ "description": "Changes the way items are previewed in the CMS while being chosen.",
6812
+ "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
6813
+ },
6814
+ "preview": {
6815
+ "$ref": "#/definitions/Preview",
6816
+ "description": "Changes the way items are previewed in the CMS.",
6817
+ "markdownDescription": "Changes the way items are previewed in the CMS."
6818
+ },
6819
+ "snippet": {
6820
+ "description": "Name of the snippet.",
6821
+ "markdownDescription": "Name of the snippet.",
6822
+ "type": "string"
6823
+ },
6824
+ "strict_whitespace": {
6825
+ "description": "Whether this snippet treats whitespace as-is or not.",
6826
+ "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
6827
+ "type": "boolean"
6828
+ },
6829
+ "template": {
6830
+ "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
6831
+ "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
6832
+ "type": "string"
6833
+ }
6834
+ },
6835
+ "type": "object"
6836
+ },
6940
6837
  "SnippetsImports": {
6941
6838
  "additionalProperties": false,
6942
6839
  "properties": {
@@ -7900,7 +7797,6 @@
7900
7797
  "markdownDescription": "Options that are specific to this `type` of input."
7901
7798
  },
7902
7799
  "type": {
7903
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
7904
7800
  "enum": [
7905
7801
  "text",
7906
7802
  "email",
@@ -7911,7 +7807,6 @@
7911
7807
  "github",
7912
7808
  "instagram"
7913
7809
  ],
7914
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
7915
7810
  "type": "string"
7916
7811
  }
7917
7812
  },
@@ -8536,6 +8431,83 @@
8536
8431
  ],
8537
8432
  "type": "string"
8538
8433
  },
8434
+ "UnknownInput": {
8435
+ "additionalProperties": false,
8436
+ "properties": {
8437
+ "cascade": {
8438
+ "default": true,
8439
+ "description": "Specifies whether or not this input configuration should be merged with any matching, less specific configuration.",
8440
+ "markdownDescription": "Specifies whether or not this input configuration should be merged with any matching, less\nspecific configuration.",
8441
+ "type": "boolean"
8442
+ },
8443
+ "comment": {
8444
+ "description": "Changes the subtext below the _Label_. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.",
8445
+ "markdownDescription": "Changes the subtext below the _Label_. Has no default. Supports a limited set of Markdown:\nlinks, bold, italic, subscript, superscript, and inline code elements are allowed.",
8446
+ "type": "string"
8447
+ },
8448
+ "context": {
8449
+ "additionalProperties": false,
8450
+ "description": "Adds an expandable section of rich text below the input.",
8451
+ "markdownDescription": "Adds an expandable section of rich text below the input.",
8452
+ "properties": {
8453
+ "content": {
8454
+ "description": "The rich text content shown when opened. Supports a limited set of Markdown.",
8455
+ "markdownDescription": "The rich text content shown when opened. Supports a limited set of Markdown.",
8456
+ "type": "string"
8457
+ },
8458
+ "icon": {
8459
+ "$ref": "#/definitions/Icon",
8460
+ "description": "The icon shown when not open.",
8461
+ "markdownDescription": "The icon shown when not open."
8462
+ },
8463
+ "open": {
8464
+ "description": "Makes the content visible initially.",
8465
+ "markdownDescription": "Makes the content visible initially.",
8466
+ "type": "boolean"
8467
+ },
8468
+ "title": {
8469
+ "description": "The text shown when not open. Defaults to \"Context\" if unset.",
8470
+ "markdownDescription": "The text shown when not open. Defaults to \"Context\" if unset.",
8471
+ "type": "string"
8472
+ }
8473
+ },
8474
+ "type": "object"
8475
+ },
8476
+ "documentation": {
8477
+ "$ref": "#/definitions/Documentation",
8478
+ "description": "Provides a custom link for documentation for editors shown above input.",
8479
+ "markdownDescription": "Provides a custom link for documentation for editors shown above input."
8480
+ },
8481
+ "hidden": {
8482
+ "default": false,
8483
+ "description": "Toggles the visibility of this input.",
8484
+ "markdownDescription": "Toggles the visibility of this input.",
8485
+ "type": [
8486
+ "boolean",
8487
+ "string"
8488
+ ]
8489
+ },
8490
+ "instance_value": {
8491
+ "$ref": "#/definitions/InstanceValue",
8492
+ "description": "Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.",
8493
+ "markdownDescription": "Controls if and how the value of this input is instantiated when created. This occurs when\ncreating files, or adding array items containing the configured input."
8494
+ },
8495
+ "label": {
8496
+ "description": "Optionally changes the text above this input.",
8497
+ "markdownDescription": "Optionally changes the text above this input.",
8498
+ "type": "string"
8499
+ },
8500
+ "options": {
8501
+ "$ref": "#/definitions/BaseInputOptions",
8502
+ "description": "Options that are specific to this `type` of input.",
8503
+ "markdownDescription": "Options that are specific to this `type` of input."
8504
+ },
8505
+ "type": {
8506
+ "type": "null"
8507
+ }
8508
+ },
8509
+ "type": "object"
8510
+ },
8539
8511
  "UrlInput": {
8540
8512
  "additionalProperties": false,
8541
8513
  "properties": {
@@ -8609,8 +8581,6 @@
8609
8581
  },
8610
8582
  "type": {
8611
8583
  "const": "range",
8612
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
8613
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
8614
8584
  "type": "string"
8615
8585
  }
8616
8586
  },
@@ -8634,84 +8604,6 @@
8634
8604
  }
8635
8605
  },
8636
8606
  "type": "object"
8637
- },
8638
- "interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487": {
8639
- "additionalProperties": false,
8640
- "properties": {
8641
- "_inputs": {
8642
- "additionalProperties": {
8643
- "$ref": "#/definitions/Input"
8644
- },
8645
- "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
8646
- "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
8647
- "type": "object"
8648
- },
8649
- "_select_data": {
8650
- "additionalProperties": {
8651
- "$ref": "#/definitions/SelectValues"
8652
- },
8653
- "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
8654
- "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
8655
- "type": "object"
8656
- },
8657
- "_structures": {
8658
- "additionalProperties": {
8659
- "$ref": "#/definitions/Structure"
8660
- },
8661
- "description": "Structured values for editors adding new items to arrays and objects. Entries here can be referenced in the configuration for `array` or `object` inputs.",
8662
- "markdownDescription": "Structured values for editors adding new items to arrays and objects. Entries here can be\nreferenced in the configuration for `array` or `object` inputs.",
8663
- "type": "object"
8664
- },
8665
- "alternate_formats": {
8666
- "description": "Alternate configurations for this snippet.",
8667
- "items": {
8668
- "$ref": "#/definitions/interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487"
8669
- },
8670
- "markdownDescription": "Alternate configurations for this snippet.",
8671
- "type": "array"
8672
- },
8673
- "definitions": {
8674
- "description": "The variables required for the selected template.",
8675
- "markdownDescription": "The variables required for the selected template.",
8676
- "type": "object"
8677
- },
8678
- "inline": {
8679
- "description": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat this snippet as a block-level element in the content editor.",
8680
- "markdownDescription": "Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat\nthis snippet as a block-level element in the content editor.",
8681
- "type": "boolean"
8682
- },
8683
- "params": {
8684
- "description": "The parameters of this snippet.",
8685
- "markdownDescription": "The parameters of this snippet.",
8686
- "type": "object"
8687
- },
8688
- "picker_preview": {
8689
- "$ref": "#/definitions/Preview",
8690
- "description": "Changes the way items are previewed in the CMS while being chosen.",
8691
- "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
8692
- },
8693
- "preview": {
8694
- "$ref": "#/definitions/Preview",
8695
- "description": "Changes the way items are previewed in the CMS.",
8696
- "markdownDescription": "Changes the way items are previewed in the CMS."
8697
- },
8698
- "snippet": {
8699
- "description": "Name of the snippet.",
8700
- "markdownDescription": "Name of the snippet.",
8701
- "type": "string"
8702
- },
8703
- "strict_whitespace": {
8704
- "description": "Whether this snippet treats whitespace as-is or not.",
8705
- "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
8706
- "type": "boolean"
8707
- },
8708
- "template": {
8709
- "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
8710
- "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
8711
- "type": "string"
8712
- }
8713
- },
8714
- "type": "object"
8715
8607
  }
8716
8608
  }
8717
8609
  }