@cloudcannon/configuration-types 0.0.4 → 0.0.5

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
  },
@@ -1036,8 +1036,6 @@
1036
1036
  },
1037
1037
  "type": {
1038
1038
  "const": "color",
1039
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
1040
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
1041
1039
  "type": "string"
1042
1040
  }
1043
1041
  },
@@ -1260,12 +1258,10 @@
1260
1258
  "markdownDescription": "Options that are specific to this `type` of input."
1261
1259
  },
1262
1260
  "type": {
1263
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
1264
1261
  "enum": [
1265
1262
  "date",
1266
1263
  "datetime"
1267
1264
  ],
1268
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
1269
1265
  "type": "string"
1270
1266
  }
1271
1267
  },
@@ -1347,82 +1343,7 @@
1347
1343
  },
1348
1344
  "_snippets": {
1349
1345
  "additionalProperties": {
1350
- "additionalProperties": false,
1351
- "properties": {
1352
- "_inputs": {
1353
- "additionalProperties": {
1354
- "$ref": "#/definitions/Input"
1355
- },
1356
- "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1357
- "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1358
- "type": "object"
1359
- },
1360
- "_select_data": {
1361
- "additionalProperties": {
1362
- "$ref": "#/definitions/SelectValues"
1363
- },
1364
- "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1365
- "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1366
- "type": "object"
1367
- },
1368
- "_structures": {
1369
- "additionalProperties": {
1370
- "$ref": "#/definitions/Structure"
1371
- },
1372
- "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.",
1373
- "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.",
1374
- "type": "object"
1375
- },
1376
- "alternate_formats": {
1377
- "description": "Alternate configurations for this snippet.",
1378
- "items": {
1379
- "$ref": "#/definitions/interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487"
1380
- },
1381
- "markdownDescription": "Alternate configurations for this snippet.",
1382
- "type": "array"
1383
- },
1384
- "definitions": {
1385
- "description": "The variables required for the selected template.",
1386
- "markdownDescription": "The variables required for the selected template.",
1387
- "type": "object"
1388
- },
1389
- "inline": {
1390
- "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.",
1391
- "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.",
1392
- "type": "boolean"
1393
- },
1394
- "params": {
1395
- "description": "The parameters of this snippet.",
1396
- "markdownDescription": "The parameters of this snippet.",
1397
- "type": "object"
1398
- },
1399
- "picker_preview": {
1400
- "$ref": "#/definitions/Preview",
1401
- "description": "Changes the way items are previewed in the CMS while being chosen.",
1402
- "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
1403
- },
1404
- "preview": {
1405
- "$ref": "#/definitions/Preview",
1406
- "description": "Changes the way items are previewed in the CMS.",
1407
- "markdownDescription": "Changes the way items are previewed in the CMS."
1408
- },
1409
- "snippet": {
1410
- "description": "Name of the snippet.",
1411
- "markdownDescription": "Name of the snippet.",
1412
- "type": "string"
1413
- },
1414
- "strict_whitespace": {
1415
- "description": "Whether this snippet treats whitespace as-is or not.",
1416
- "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
1417
- "type": "boolean"
1418
- },
1419
- "template": {
1420
- "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1421
- "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1422
- "type": "string"
1423
- }
1424
- },
1425
- "type": "object"
1346
+ "$ref": "#/definitions/SnippetConfig"
1426
1347
  },
1427
1348
  "description": "Configuration for custom snippets.",
1428
1349
  "markdownDescription": "Configuration for custom snippets.",
@@ -1430,82 +1351,7 @@
1430
1351
  },
1431
1352
  "_snippets_definitions": {
1432
1353
  "additionalProperties": {
1433
- "additionalProperties": false,
1434
- "properties": {
1435
- "_inputs": {
1436
- "additionalProperties": {
1437
- "$ref": "#/definitions/Input"
1438
- },
1439
- "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1440
- "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1441
- "type": "object"
1442
- },
1443
- "_select_data": {
1444
- "additionalProperties": {
1445
- "$ref": "#/definitions/SelectValues"
1446
- },
1447
- "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1448
- "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1449
- "type": "object"
1450
- },
1451
- "_structures": {
1452
- "additionalProperties": {
1453
- "$ref": "#/definitions/Structure"
1454
- },
1455
- "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.",
1456
- "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.",
1457
- "type": "object"
1458
- },
1459
- "alternate_formats": {
1460
- "description": "Alternate configurations for this snippet.",
1461
- "items": {
1462
- "$ref": "#/definitions/interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487"
1463
- },
1464
- "markdownDescription": "Alternate configurations for this snippet.",
1465
- "type": "array"
1466
- },
1467
- "definitions": {
1468
- "description": "The variables required for the selected template.",
1469
- "markdownDescription": "The variables required for the selected template.",
1470
- "type": "object"
1471
- },
1472
- "inline": {
1473
- "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.",
1474
- "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.",
1475
- "type": "boolean"
1476
- },
1477
- "params": {
1478
- "description": "The parameters of this snippet.",
1479
- "markdownDescription": "The parameters of this snippet.",
1480
- "type": "object"
1481
- },
1482
- "picker_preview": {
1483
- "$ref": "#/definitions/Preview",
1484
- "description": "Changes the way items are previewed in the CMS while being chosen.",
1485
- "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
1486
- },
1487
- "preview": {
1488
- "$ref": "#/definitions/Preview",
1489
- "description": "Changes the way items are previewed in the CMS.",
1490
- "markdownDescription": "Changes the way items are previewed in the CMS."
1491
- },
1492
- "snippet": {
1493
- "description": "Name of the snippet.",
1494
- "markdownDescription": "Name of the snippet.",
1495
- "type": "string"
1496
- },
1497
- "strict_whitespace": {
1498
- "description": "Whether this snippet treats whitespace as-is or not.",
1499
- "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
1500
- "type": "boolean"
1501
- },
1502
- "template": {
1503
- "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1504
- "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1505
- "type": "string"
1506
- }
1507
- },
1508
- "type": "object"
1354
+ "$ref": "#/definitions/SnippetConfig"
1509
1355
  },
1510
1356
  "description": "Extended option used when creating more complex custom snippets.",
1511
1357
  "markdownDescription": "Extended option used when creating more complex custom snippets.",
@@ -1518,82 +1364,7 @@
1518
1364
  },
1519
1365
  "_snippets_templates": {
1520
1366
  "additionalProperties": {
1521
- "additionalProperties": false,
1522
- "properties": {
1523
- "_inputs": {
1524
- "additionalProperties": {
1525
- "$ref": "#/definitions/Input"
1526
- },
1527
- "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1528
- "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1529
- "type": "object"
1530
- },
1531
- "_select_data": {
1532
- "additionalProperties": {
1533
- "$ref": "#/definitions/SelectValues"
1534
- },
1535
- "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1536
- "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1537
- "type": "object"
1538
- },
1539
- "_structures": {
1540
- "additionalProperties": {
1541
- "$ref": "#/definitions/Structure"
1542
- },
1543
- "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.",
1544
- "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.",
1545
- "type": "object"
1546
- },
1547
- "alternate_formats": {
1548
- "description": "Alternate configurations for this snippet.",
1549
- "items": {
1550
- "$ref": "#/definitions/interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487"
1551
- },
1552
- "markdownDescription": "Alternate configurations for this snippet.",
1553
- "type": "array"
1554
- },
1555
- "definitions": {
1556
- "description": "The variables required for the selected template.",
1557
- "markdownDescription": "The variables required for the selected template.",
1558
- "type": "object"
1559
- },
1560
- "inline": {
1561
- "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.",
1562
- "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.",
1563
- "type": "boolean"
1564
- },
1565
- "params": {
1566
- "description": "The parameters of this snippet.",
1567
- "markdownDescription": "The parameters of this snippet.",
1568
- "type": "object"
1569
- },
1570
- "picker_preview": {
1571
- "$ref": "#/definitions/Preview",
1572
- "description": "Changes the way items are previewed in the CMS while being chosen.",
1573
- "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
1574
- },
1575
- "preview": {
1576
- "$ref": "#/definitions/Preview",
1577
- "description": "Changes the way items are previewed in the CMS.",
1578
- "markdownDescription": "Changes the way items are previewed in the CMS."
1579
- },
1580
- "snippet": {
1581
- "description": "Name of the snippet.",
1582
- "markdownDescription": "Name of the snippet.",
1583
- "type": "string"
1584
- },
1585
- "strict_whitespace": {
1586
- "description": "Whether this snippet treats whitespace as-is or not.",
1587
- "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
1588
- "type": "boolean"
1589
- },
1590
- "template": {
1591
- "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1592
- "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
1593
- "type": "string"
1594
- }
1595
- },
1596
- "type": "object"
1367
+ "$ref": "#/definitions/SnippetConfig"
1597
1368
  },
1598
1369
  "description": "Extended option used when creating more complex custom snippets.",
1599
1370
  "markdownDescription": "Extended option used when creating more complex custom snippets.",
@@ -1913,12 +1684,10 @@
1913
1684
  "markdownDescription": "Options that are specific to this `type` of input."
1914
1685
  },
1915
1686
  "type": {
1916
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
1917
1687
  "enum": [
1918
1688
  "file",
1919
1689
  "document"
1920
1690
  ],
1921
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
1922
1691
  "type": "string"
1923
1692
  }
1924
1693
  },
@@ -1946,6 +1715,14 @@
1946
1715
  "description": "Restricts which file types are available to select or upload to this input.",
1947
1716
  "markdownDescription": "Restricts which file types are available to select or upload to this input."
1948
1717
  },
1718
+ "allowed_sources": {
1719
+ "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.",
1720
+ "items": {
1721
+ "type": "string"
1722
+ },
1723
+ "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.",
1724
+ "type": "array"
1725
+ },
1949
1726
  "empty_type": {
1950
1727
  "$ref": "#/definitions/EmptyTypeText",
1951
1728
  "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
@@ -4189,27 +3966,28 @@
4189
3966
  "type": "string"
4190
3967
  },
4191
3968
  "sizes": {
4192
- "additionalProperties": false,
4193
3969
  "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
4194
- "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
4195
- "properties": {
4196
- "size": {
4197
- "const": "string",
4198
- "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).",
4199
- "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).",
4200
- "type": "string"
3970
+ "items": {
3971
+ "additionalProperties": false,
3972
+ "properties": {
3973
+ "size": {
3974
+ "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).",
3975
+ "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).",
3976
+ "type": "string"
3977
+ },
3978
+ "target": {
3979
+ "description": "A reference to another input that is given the path to this additional image file.",
3980
+ "markdownDescription": "A reference to another input that is given the path to this additional image file.",
3981
+ "type": "string"
3982
+ }
4201
3983
  },
4202
- "target": {
4203
- "const": "string",
4204
- "description": "A reference to another input that is given the path to this additional image file.",
4205
- "markdownDescription": "A reference to another input that is given the path to this additional image file.",
4206
- "type": "string"
4207
- }
3984
+ "required": [
3985
+ "size"
3986
+ ],
3987
+ "type": "object"
4208
3988
  },
4209
- "required": [
4210
- "size"
4211
- ],
4212
- "type": "object"
3989
+ "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
3990
+ "type": "array"
4213
3991
  },
4214
3992
  "width": {
4215
3993
  "description": "Defines the width of the bounding box used in the image resizing process defined with resize_style.",
@@ -4292,8 +4070,6 @@
4292
4070
  },
4293
4071
  "type": {
4294
4072
  "const": "image",
4295
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
4296
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
4297
4073
  "type": "string"
4298
4074
  }
4299
4075
  },
@@ -4390,27 +4166,28 @@
4390
4166
  "type": "string"
4391
4167
  },
4392
4168
  "sizes": {
4393
- "additionalProperties": false,
4394
4169
  "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
4395
- "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
4396
- "properties": {
4397
- "size": {
4398
- "const": "string",
4399
- "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).",
4400
- "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).",
4401
- "type": "string"
4170
+ "items": {
4171
+ "additionalProperties": false,
4172
+ "properties": {
4173
+ "size": {
4174
+ "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).",
4175
+ "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).",
4176
+ "type": "string"
4177
+ },
4178
+ "target": {
4179
+ "description": "A reference to another input that is given the path to this additional image file.",
4180
+ "markdownDescription": "A reference to another input that is given the path to this additional image file.",
4181
+ "type": "string"
4182
+ }
4402
4183
  },
4403
- "target": {
4404
- "const": "string",
4405
- "description": "A reference to another input that is given the path to this additional image file.",
4406
- "markdownDescription": "A reference to another input that is given the path to this additional image file.",
4407
- "type": "string"
4408
- }
4184
+ "required": [
4185
+ "size"
4186
+ ],
4187
+ "type": "object"
4409
4188
  },
4410
- "required": [
4411
- "size"
4412
- ],
4413
- "type": "object"
4189
+ "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
4190
+ "type": "array"
4414
4191
  },
4415
4192
  "width": {
4416
4193
  "description": "Defines the width of the bounding box used in the image resizing process defined with resize_style.",
@@ -4425,6 +4202,9 @@
4425
4202
  {
4426
4203
  "$ref": "#/definitions/BaseInput"
4427
4204
  },
4205
+ {
4206
+ "$ref": "#/definitions/UnknownInput"
4207
+ },
4428
4208
  {
4429
4209
  "$ref": "#/definitions/TextInput"
4430
4210
  },
@@ -5039,8 +4819,6 @@
5039
4819
  },
5040
4820
  "type": {
5041
4821
  "const": "multichoice",
5042
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
5043
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
5044
4822
  "type": "string"
5045
4823
  }
5046
4824
  },
@@ -5154,8 +4932,6 @@
5154
4932
  },
5155
4933
  "type": {
5156
4934
  "const": "multiselect",
5157
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
5158
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
5159
4935
  "type": "string"
5160
4936
  }
5161
4937
  },
@@ -5270,8 +5046,6 @@
5270
5046
  },
5271
5047
  "type": {
5272
5048
  "const": "number",
5273
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
5274
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
5275
5049
  "type": "string"
5276
5050
  }
5277
5051
  },
@@ -5379,8 +5153,6 @@
5379
5153
  },
5380
5154
  "type": {
5381
5155
  "const": "object",
5382
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
5383
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
5384
5156
  "type": "string"
5385
5157
  }
5386
5158
  },
@@ -5389,9 +5161,38 @@
5389
5161
  ],
5390
5162
  "type": "object"
5391
5163
  },
5164
+ "ObjectInputGroup": {
5165
+ "additionalProperties": false,
5166
+ "properties": {
5167
+ "collapsed": {
5168
+ "type": "boolean"
5169
+ },
5170
+ "comment": {
5171
+ "type": "string"
5172
+ },
5173
+ "documentation": {
5174
+ "$ref": "#/definitions/Documentation"
5175
+ },
5176
+ "heading": {
5177
+ "type": "string"
5178
+ },
5179
+ "inputs": {
5180
+ "items": {
5181
+ "type": "string"
5182
+ },
5183
+ "type": "array"
5184
+ }
5185
+ },
5186
+ "type": "object"
5187
+ },
5392
5188
  "ObjectInputOptions": {
5393
5189
  "additionalProperties": false,
5394
5190
  "properties": {
5191
+ "allow_label_formatting": {
5192
+ "description": "Controls whether or not labels on mutable object entries are formatted.",
5193
+ "markdownDescription": "Controls whether or not labels on mutable object entries are formatted.",
5194
+ "type": "boolean"
5195
+ },
5395
5196
  "empty_type": {
5396
5197
  "$ref": "#/definitions/EmptyTypeObject",
5397
5198
  "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
@@ -5436,6 +5237,19 @@
5436
5237
  },
5437
5238
  "type": "object"
5438
5239
  },
5240
+ "groups": {
5241
+ "description": "Allows you to group the inputs inside this object together without changing the data structure.",
5242
+ "items": {
5243
+ "$ref": "#/definitions/ObjectInputGroup"
5244
+ },
5245
+ "markdownDescription": "Allows you to group the inputs inside this object together without changing the data structure.",
5246
+ "type": "array"
5247
+ },
5248
+ "place_groups_below": {
5249
+ "description": "Controls which order input groups and ungrouped inputs appear in.",
5250
+ "markdownDescription": "Controls which order input groups and ungrouped inputs appear in.",
5251
+ "type": "boolean"
5252
+ },
5439
5253
  "preview": {
5440
5254
  "$ref": "#/definitions/ObjectPreview",
5441
5255
  "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.",
@@ -5683,6 +5497,11 @@
5683
5497
  "description": "Filename template for newly uploaded site files.",
5684
5498
  "markdownDescription": "Filename template for newly uploaded site files.",
5685
5499
  "type": "string"
5500
+ },
5501
+ "uploads_use_relative_path": {
5502
+ "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
5503
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
5504
+ "type": "boolean"
5686
5505
  }
5687
5506
  },
5688
5507
  "type": "object"
@@ -6207,8 +6026,6 @@
6207
6026
  },
6208
6027
  "type": {
6209
6028
  "const": "range",
6210
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
6211
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
6212
6029
  "type": "string"
6213
6030
  }
6214
6031
  },
@@ -6283,6 +6100,11 @@
6283
6100
  "description": "Filename template for newly uploaded site files.",
6284
6101
  "markdownDescription": "Filename template for newly uploaded site files.",
6285
6102
  "type": "string"
6103
+ },
6104
+ "uploads_use_relative_path": {
6105
+ "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
6106
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
6107
+ "type": "boolean"
6286
6108
  }
6287
6109
  },
6288
6110
  "type": "object"
@@ -6359,12 +6181,10 @@
6359
6181
  "markdownDescription": "Options that are specific to this `type` of input."
6360
6182
  },
6361
6183
  "type": {
6362
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
6363
6184
  "enum": [
6364
6185
  "html",
6365
6186
  "markdown"
6366
6187
  ],
6367
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
6368
6188
  "type": "string"
6369
6189
  }
6370
6190
  },
@@ -6565,27 +6385,28 @@
6565
6385
  "type": "string"
6566
6386
  },
6567
6387
  "sizes": {
6568
- "additionalProperties": false,
6569
6388
  "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
6570
- "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
6571
- "properties": {
6572
- "size": {
6573
- "const": "string",
6574
- "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).",
6575
- "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).",
6576
- "type": "string"
6389
+ "items": {
6390
+ "additionalProperties": false,
6391
+ "properties": {
6392
+ "size": {
6393
+ "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).",
6394
+ "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).",
6395
+ "type": "string"
6396
+ },
6397
+ "target": {
6398
+ "description": "A reference to another input that is given the path to this additional image file.",
6399
+ "markdownDescription": "A reference to another input that is given the path to this additional image file.",
6400
+ "type": "string"
6401
+ }
6577
6402
  },
6578
- "target": {
6579
- "const": "string",
6580
- "description": "A reference to another input that is given the path to this additional image file.",
6581
- "markdownDescription": "A reference to another input that is given the path to this additional image file.",
6582
- "type": "string"
6583
- }
6403
+ "required": [
6404
+ "size"
6405
+ ],
6406
+ "type": "object"
6584
6407
  },
6585
- "required": [
6586
- "size"
6587
- ],
6588
- "type": "object"
6408
+ "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
6409
+ "type": "array"
6589
6410
  },
6590
6411
  "snippet": {
6591
6412
  "description": "Enables a control to insert snippets, if any are available.",
@@ -6832,8 +6653,6 @@
6832
6653
  },
6833
6654
  "type": {
6834
6655
  "const": "select",
6835
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
6836
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
6837
6656
  "type": "string"
6838
6657
  }
6839
6658
  },
@@ -6984,6 +6803,84 @@
6984
6803
  }
6985
6804
  ]
6986
6805
  },
6806
+ "SnippetConfig": {
6807
+ "additionalProperties": false,
6808
+ "properties": {
6809
+ "_inputs": {
6810
+ "additionalProperties": {
6811
+ "$ref": "#/definitions/Input"
6812
+ },
6813
+ "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
6814
+ "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
6815
+ "type": "object"
6816
+ },
6817
+ "_select_data": {
6818
+ "additionalProperties": {
6819
+ "$ref": "#/definitions/SelectValues"
6820
+ },
6821
+ "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
6822
+ "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
6823
+ "type": "object"
6824
+ },
6825
+ "_structures": {
6826
+ "additionalProperties": {
6827
+ "$ref": "#/definitions/Structure"
6828
+ },
6829
+ "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.",
6830
+ "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.",
6831
+ "type": "object"
6832
+ },
6833
+ "alternate_formats": {
6834
+ "description": "Alternate configurations for this snippet.",
6835
+ "items": {
6836
+ "$ref": "#/definitions/SnippetConfig"
6837
+ },
6838
+ "markdownDescription": "Alternate configurations for this snippet.",
6839
+ "type": "array"
6840
+ },
6841
+ "definitions": {
6842
+ "description": "The variables required for the selected template.",
6843
+ "markdownDescription": "The variables required for the selected template.",
6844
+ "type": "object"
6845
+ },
6846
+ "inline": {
6847
+ "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.",
6848
+ "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.",
6849
+ "type": "boolean"
6850
+ },
6851
+ "params": {
6852
+ "description": "The parameters of this snippet.",
6853
+ "markdownDescription": "The parameters of this snippet.",
6854
+ "type": "object"
6855
+ },
6856
+ "picker_preview": {
6857
+ "$ref": "#/definitions/Preview",
6858
+ "description": "Changes the way items are previewed in the CMS while being chosen.",
6859
+ "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
6860
+ },
6861
+ "preview": {
6862
+ "$ref": "#/definitions/Preview",
6863
+ "description": "Changes the way items are previewed in the CMS.",
6864
+ "markdownDescription": "Changes the way items are previewed in the CMS."
6865
+ },
6866
+ "snippet": {
6867
+ "description": "Name of the snippet.",
6868
+ "markdownDescription": "Name of the snippet.",
6869
+ "type": "string"
6870
+ },
6871
+ "strict_whitespace": {
6872
+ "description": "Whether this snippet treats whitespace as-is or not.",
6873
+ "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
6874
+ "type": "boolean"
6875
+ },
6876
+ "template": {
6877
+ "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
6878
+ "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
6879
+ "type": "string"
6880
+ }
6881
+ },
6882
+ "type": "object"
6883
+ },
6987
6884
  "SnippetsImports": {
6988
6885
  "additionalProperties": false,
6989
6886
  "properties": {
@@ -7968,7 +7865,6 @@
7968
7865
  "markdownDescription": "Options that are specific to this `type` of input."
7969
7866
  },
7970
7867
  "type": {
7971
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
7972
7868
  "enum": [
7973
7869
  "text",
7974
7870
  "email",
@@ -7979,7 +7875,6 @@
7979
7875
  "github",
7980
7876
  "instagram"
7981
7877
  ],
7982
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
7983
7878
  "type": "string"
7984
7879
  }
7985
7880
  },
@@ -8604,6 +8499,83 @@
8604
8499
  ],
8605
8500
  "type": "string"
8606
8501
  },
8502
+ "UnknownInput": {
8503
+ "additionalProperties": false,
8504
+ "properties": {
8505
+ "cascade": {
8506
+ "default": true,
8507
+ "description": "Specifies whether or not this input configuration should be merged with any matching, less specific configuration.",
8508
+ "markdownDescription": "Specifies whether or not this input configuration should be merged with any matching, less\nspecific configuration.",
8509
+ "type": "boolean"
8510
+ },
8511
+ "comment": {
8512
+ "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.",
8513
+ "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.",
8514
+ "type": "string"
8515
+ },
8516
+ "context": {
8517
+ "additionalProperties": false,
8518
+ "description": "Adds an expandable section of rich text below the input.",
8519
+ "markdownDescription": "Adds an expandable section of rich text below the input.",
8520
+ "properties": {
8521
+ "content": {
8522
+ "description": "The rich text content shown when opened. Supports a limited set of Markdown.",
8523
+ "markdownDescription": "The rich text content shown when opened. Supports a limited set of Markdown.",
8524
+ "type": "string"
8525
+ },
8526
+ "icon": {
8527
+ "$ref": "#/definitions/Icon",
8528
+ "description": "The icon shown when not open.",
8529
+ "markdownDescription": "The icon shown when not open."
8530
+ },
8531
+ "open": {
8532
+ "description": "Makes the content visible initially.",
8533
+ "markdownDescription": "Makes the content visible initially.",
8534
+ "type": "boolean"
8535
+ },
8536
+ "title": {
8537
+ "description": "The text shown when not open. Defaults to \"Context\" if unset.",
8538
+ "markdownDescription": "The text shown when not open. Defaults to \"Context\" if unset.",
8539
+ "type": "string"
8540
+ }
8541
+ },
8542
+ "type": "object"
8543
+ },
8544
+ "documentation": {
8545
+ "$ref": "#/definitions/Documentation",
8546
+ "description": "Provides a custom link for documentation for editors shown above input.",
8547
+ "markdownDescription": "Provides a custom link for documentation for editors shown above input."
8548
+ },
8549
+ "hidden": {
8550
+ "default": false,
8551
+ "description": "Toggles the visibility of this input.",
8552
+ "markdownDescription": "Toggles the visibility of this input.",
8553
+ "type": [
8554
+ "boolean",
8555
+ "string"
8556
+ ]
8557
+ },
8558
+ "instance_value": {
8559
+ "$ref": "#/definitions/InstanceValue",
8560
+ "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.",
8561
+ "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."
8562
+ },
8563
+ "label": {
8564
+ "description": "Optionally changes the text above this input.",
8565
+ "markdownDescription": "Optionally changes the text above this input.",
8566
+ "type": "string"
8567
+ },
8568
+ "options": {
8569
+ "$ref": "#/definitions/BaseInputOptions",
8570
+ "description": "Options that are specific to this `type` of input.",
8571
+ "markdownDescription": "Options that are specific to this `type` of input."
8572
+ },
8573
+ "type": {
8574
+ "type": "null"
8575
+ }
8576
+ },
8577
+ "type": "object"
8578
+ },
8607
8579
  "UrlInput": {
8608
8580
  "additionalProperties": false,
8609
8581
  "properties": {
@@ -8677,8 +8649,6 @@
8677
8649
  },
8678
8650
  "type": {
8679
8651
  "const": "range",
8680
- "description": "Controls the type of input, changing how it is displayed and interacted with.",
8681
- "markdownDescription": "Controls the type of input, changing how it is displayed and interacted with.",
8682
8652
  "type": "string"
8683
8653
  }
8684
8654
  },
@@ -8702,84 +8672,6 @@
8702
8672
  }
8703
8673
  },
8704
8674
  "type": "object"
8705
- },
8706
- "interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487": {
8707
- "additionalProperties": false,
8708
- "properties": {
8709
- "_inputs": {
8710
- "additionalProperties": {
8711
- "$ref": "#/definitions/Input"
8712
- },
8713
- "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
8714
- "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
8715
- "type": "object"
8716
- },
8717
- "_select_data": {
8718
- "additionalProperties": {
8719
- "$ref": "#/definitions/SelectValues"
8720
- },
8721
- "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
8722
- "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
8723
- "type": "object"
8724
- },
8725
- "_structures": {
8726
- "additionalProperties": {
8727
- "$ref": "#/definitions/Structure"
8728
- },
8729
- "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.",
8730
- "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.",
8731
- "type": "object"
8732
- },
8733
- "alternate_formats": {
8734
- "description": "Alternate configurations for this snippet.",
8735
- "items": {
8736
- "$ref": "#/definitions/interface-src_index.d.ts-483-1457-src_index.d.ts-0-47487"
8737
- },
8738
- "markdownDescription": "Alternate configurations for this snippet.",
8739
- "type": "array"
8740
- },
8741
- "definitions": {
8742
- "description": "The variables required for the selected template.",
8743
- "markdownDescription": "The variables required for the selected template.",
8744
- "type": "object"
8745
- },
8746
- "inline": {
8747
- "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.",
8748
- "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.",
8749
- "type": "boolean"
8750
- },
8751
- "params": {
8752
- "description": "The parameters of this snippet.",
8753
- "markdownDescription": "The parameters of this snippet.",
8754
- "type": "object"
8755
- },
8756
- "picker_preview": {
8757
- "$ref": "#/definitions/Preview",
8758
- "description": "Changes the way items are previewed in the CMS while being chosen.",
8759
- "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
8760
- },
8761
- "preview": {
8762
- "$ref": "#/definitions/Preview",
8763
- "description": "Changes the way items are previewed in the CMS.",
8764
- "markdownDescription": "Changes the way items are previewed in the CMS."
8765
- },
8766
- "snippet": {
8767
- "description": "Name of the snippet.",
8768
- "markdownDescription": "Name of the snippet.",
8769
- "type": "string"
8770
- },
8771
- "strict_whitespace": {
8772
- "description": "Whether this snippet treats whitespace as-is or not.",
8773
- "markdownDescription": "Whether this snippet treats whitespace as-is or not.",
8774
- "type": "boolean"
8775
- },
8776
- "template": {
8777
- "description": "The template that this snippet should inherit, out of the available Shortcode Templates.",
8778
- "markdownDescription": "The template that this snippet should inherit, out of the available Shortcode Templates.",
8779
- "type": "string"
8780
- }
8781
- },
8782
- "type": "object"
8783
8675
  }
8784
8676
  }
8785
8677
  }