@cloudcannon/configuration-types 0.0.5 → 0.0.7

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.
@@ -853,6 +853,21 @@
853
853
  "description": "Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.",
854
854
  "markdownDescription": "Controls which files are displayed in the collection list. Does not change which files are\nassigned to this collection."
855
855
  },
856
+ "glob": {
857
+ "anyOf": [
858
+ {
859
+ "type": "string"
860
+ },
861
+ {
862
+ "items": {
863
+ "type": "string"
864
+ },
865
+ "type": "array"
866
+ }
867
+ ],
868
+ "description": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.",
869
+ "markdownDescription": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`."
870
+ },
856
871
  "icon": {
857
872
  "$ref": "#/definitions/Icon",
858
873
  "description": "Sets an icon to use alongside references to this collection.",
@@ -887,8 +902,8 @@
887
902
  "type": "string"
888
903
  },
889
904
  "path": {
890
- "description": "The top-most folder where the files in this collection are stored. It is relative to source. Each collection must have a unique path.",
891
- "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.\nEach collection must have a unique path.",
905
+ "description": "The top-most folder where the files in this collection are stored. It is relative to source.",
906
+ "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
892
907
  "type": "string"
893
908
  },
894
909
  "preview": {
@@ -1418,6 +1433,14 @@
1418
1433
  "description": "Contains settings for the default editor actions on your site.",
1419
1434
  "markdownDescription": "Contains settings for the default editor actions on your site."
1420
1435
  },
1436
+ "file_config": {
1437
+ "additionalProperties": {
1438
+ "$ref": "#/definitions/FileConfigEntry"
1439
+ },
1440
+ "description": "Provides scope to configure at a file level, without adding configuration to files.",
1441
+ "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
1442
+ "type": "object"
1443
+ },
1421
1444
  "generator": {
1422
1445
  "additionalProperties": false,
1423
1446
  "description": "Contains settings for various Markdown engines.",
@@ -1612,6 +1635,90 @@
1612
1635
  ],
1613
1636
  "type": "string"
1614
1637
  },
1638
+ "FileConfigEntry": {
1639
+ "additionalProperties": false,
1640
+ "properties": {
1641
+ "_array_structures": {
1642
+ "additionalProperties": {},
1643
+ "description": "[DEPRECATED] Now known as _structures.",
1644
+ "markdownDescription": "[DEPRECATED] Now known as _structures.",
1645
+ "type": "object"
1646
+ },
1647
+ "_comments": {
1648
+ "additionalProperties": {
1649
+ "type": "string"
1650
+ },
1651
+ "description": "[DEPRECATED] Now part of _inputs.*.comment.",
1652
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.comment.",
1653
+ "type": "object"
1654
+ },
1655
+ "_editables": {
1656
+ "$ref": "#/definitions/Editables",
1657
+ "description": "Contains input options for Editable Regions and the Content Editor.",
1658
+ "markdownDescription": "Contains input options for Editable Regions and the Content Editor."
1659
+ },
1660
+ "_enabled_editors": {
1661
+ "description": "Set a preferred editor and/or disable the others. The first value sets which editor opens by default, and the following values specify which editors are accessible.",
1662
+ "items": {
1663
+ "$ref": "#/definitions/EditorKey"
1664
+ },
1665
+ "markdownDescription": "Set a preferred editor and/or disable the others. The first value sets which editor opens by\ndefault, and the following values specify which editors are accessible.",
1666
+ "type": "array"
1667
+ },
1668
+ "_inputs": {
1669
+ "additionalProperties": {
1670
+ "$ref": "#/definitions/Input"
1671
+ },
1672
+ "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1673
+ "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1674
+ "type": "object"
1675
+ },
1676
+ "_options": {
1677
+ "additionalProperties": {
1678
+ "additionalProperties": {},
1679
+ "type": "object"
1680
+ },
1681
+ "description": "[DEPRECATED] Now part of _inputs.*.options.",
1682
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.options.",
1683
+ "type": "object"
1684
+ },
1685
+ "_select_data": {
1686
+ "additionalProperties": {
1687
+ "$ref": "#/definitions/SelectValues"
1688
+ },
1689
+ "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1690
+ "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1691
+ "type": "object"
1692
+ },
1693
+ "_structures": {
1694
+ "additionalProperties": {
1695
+ "$ref": "#/definitions/Structure"
1696
+ },
1697
+ "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.",
1698
+ "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.",
1699
+ "type": "object"
1700
+ },
1701
+ "glob": {
1702
+ "anyOf": [
1703
+ {
1704
+ "type": "string"
1705
+ },
1706
+ {
1707
+ "items": {
1708
+ "type": "string"
1709
+ },
1710
+ "type": "array"
1711
+ }
1712
+ ],
1713
+ "description": "The glob pattern(s) targeting a path to one or more files.",
1714
+ "markdownDescription": "The glob pattern(s) targeting a path to one or more files."
1715
+ }
1716
+ },
1717
+ "required": [
1718
+ "glob"
1719
+ ],
1720
+ "type": "object"
1721
+ },
1615
1722
  "FileInput": {
1616
1723
  "additionalProperties": false,
1617
1724
  "properties": {
@@ -5500,7 +5607,7 @@
5500
5607
  },
5501
5608
  "uploads_use_relative_path": {
5502
5609
  "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.",
5610
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
5504
5611
  "type": "boolean"
5505
5612
  }
5506
5613
  },
@@ -6103,7 +6210,7 @@
6103
6210
  },
6104
6211
  "uploads_use_relative_path": {
6105
6212
  "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.",
6213
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
6107
6214
  "type": "boolean"
6108
6215
  }
6109
6216
  },
@@ -7402,6 +7509,8 @@
7402
7509
  "nuxtjs",
7403
7510
  "sphinx",
7404
7511
  "static",
7512
+ "other",
7513
+ "legacy",
7405
7514
  "unknown"
7406
7515
  ],
7407
7516
  "type": "string"
@@ -1356,6 +1356,21 @@
1356
1356
  "description": "Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.",
1357
1357
  "markdownDescription": "Controls which files are displayed in the collection list. Does not change which files are\nassigned to this collection."
1358
1358
  },
1359
+ "glob": {
1360
+ "anyOf": [
1361
+ {
1362
+ "type": "string"
1363
+ },
1364
+ {
1365
+ "items": {
1366
+ "type": "string"
1367
+ },
1368
+ "type": "array"
1369
+ }
1370
+ ],
1371
+ "description": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.",
1372
+ "markdownDescription": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`."
1373
+ },
1359
1374
  "icon": {
1360
1375
  "$ref": "#/definitions/Icon",
1361
1376
  "description": "Sets an icon to use alongside references to this collection.",
@@ -1377,8 +1392,8 @@
1377
1392
  "type": "boolean"
1378
1393
  },
1379
1394
  "path": {
1380
- "description": "The top-most folder where the files in this collection are stored. It is relative to source. Each collection must have a unique path.",
1381
- "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.\nEach collection must have a unique path.",
1395
+ "description": "The top-most folder where the files in this collection are stored. It is relative to source.",
1396
+ "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
1382
1397
  "type": "string"
1383
1398
  },
1384
1399
  "preview": {
@@ -1453,6 +1468,14 @@
1453
1468
  "description": "Contains settings for the default editor actions on your site.",
1454
1469
  "markdownDescription": "Contains settings for the default editor actions on your site."
1455
1470
  },
1471
+ "file_config": {
1472
+ "additionalProperties": {
1473
+ "$ref": "#/definitions/FileConfigEntry"
1474
+ },
1475
+ "description": "Provides scope to configure at a file level, without adding configuration to files.",
1476
+ "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
1477
+ "type": "object"
1478
+ },
1456
1479
  "generator": {
1457
1480
  "additionalProperties": false,
1458
1481
  "description": "Contains settings for various Markdown engines.",
@@ -1565,6 +1588,90 @@
1565
1588
  ],
1566
1589
  "type": "string"
1567
1590
  },
1591
+ "FileConfigEntry": {
1592
+ "additionalProperties": false,
1593
+ "properties": {
1594
+ "_array_structures": {
1595
+ "additionalProperties": {},
1596
+ "description": "[DEPRECATED] Now known as _structures.",
1597
+ "markdownDescription": "[DEPRECATED] Now known as _structures.",
1598
+ "type": "object"
1599
+ },
1600
+ "_comments": {
1601
+ "additionalProperties": {
1602
+ "type": "string"
1603
+ },
1604
+ "description": "[DEPRECATED] Now part of _inputs.*.comment.",
1605
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.comment.",
1606
+ "type": "object"
1607
+ },
1608
+ "_editables": {
1609
+ "$ref": "#/definitions/Editables",
1610
+ "description": "Contains input options for Editable Regions and the Content Editor.",
1611
+ "markdownDescription": "Contains input options for Editable Regions and the Content Editor."
1612
+ },
1613
+ "_enabled_editors": {
1614
+ "description": "Set a preferred editor and/or disable the others. The first value sets which editor opens by default, and the following values specify which editors are accessible.",
1615
+ "items": {
1616
+ "$ref": "#/definitions/EditorKey"
1617
+ },
1618
+ "markdownDescription": "Set a preferred editor and/or disable the others. The first value sets which editor opens by\ndefault, and the following values specify which editors are accessible.",
1619
+ "type": "array"
1620
+ },
1621
+ "_inputs": {
1622
+ "additionalProperties": {
1623
+ "$ref": "#/definitions/Input"
1624
+ },
1625
+ "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1626
+ "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1627
+ "type": "object"
1628
+ },
1629
+ "_options": {
1630
+ "additionalProperties": {
1631
+ "additionalProperties": {},
1632
+ "type": "object"
1633
+ },
1634
+ "description": "[DEPRECATED] Now part of _inputs.*.options.",
1635
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.options.",
1636
+ "type": "object"
1637
+ },
1638
+ "_select_data": {
1639
+ "additionalProperties": {
1640
+ "$ref": "#/definitions/SelectValues"
1641
+ },
1642
+ "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1643
+ "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1644
+ "type": "object"
1645
+ },
1646
+ "_structures": {
1647
+ "additionalProperties": {
1648
+ "$ref": "#/definitions/Structure"
1649
+ },
1650
+ "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.",
1651
+ "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.",
1652
+ "type": "object"
1653
+ },
1654
+ "glob": {
1655
+ "anyOf": [
1656
+ {
1657
+ "type": "string"
1658
+ },
1659
+ {
1660
+ "items": {
1661
+ "type": "string"
1662
+ },
1663
+ "type": "array"
1664
+ }
1665
+ ],
1666
+ "description": "The glob pattern(s) targeting a path to one or more files.",
1667
+ "markdownDescription": "The glob pattern(s) targeting a path to one or more files."
1668
+ }
1669
+ },
1670
+ "required": [
1671
+ "glob"
1672
+ ],
1673
+ "type": "object"
1674
+ },
1568
1675
  "FileInput": {
1569
1676
  "additionalProperties": false,
1570
1677
  "properties": {
@@ -5453,7 +5560,7 @@
5453
5560
  },
5454
5561
  "uploads_use_relative_path": {
5455
5562
  "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 uploaded to.",
5563
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
5457
5564
  "type": "boolean"
5458
5565
  }
5459
5566
  },
@@ -6056,7 +6163,7 @@
6056
6163
  },
6057
6164
  "uploads_use_relative_path": {
6058
6165
  "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 uploaded to.",
6166
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
6060
6167
  "type": "boolean"
6061
6168
  }
6062
6169
  },
@@ -1165,6 +1165,90 @@
1165
1165
  ],
1166
1166
  "type": "string"
1167
1167
  },
1168
+ "FileConfigEntry": {
1169
+ "additionalProperties": false,
1170
+ "properties": {
1171
+ "_array_structures": {
1172
+ "additionalProperties": {},
1173
+ "description": "[DEPRECATED] Now known as _structures.",
1174
+ "markdownDescription": "[DEPRECATED] Now known as _structures.",
1175
+ "type": "object"
1176
+ },
1177
+ "_comments": {
1178
+ "additionalProperties": {
1179
+ "type": "string"
1180
+ },
1181
+ "description": "[DEPRECATED] Now part of _inputs.*.comment.",
1182
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.comment.",
1183
+ "type": "object"
1184
+ },
1185
+ "_editables": {
1186
+ "$ref": "#/definitions/Editables",
1187
+ "description": "Contains input options for Editable Regions and the Content Editor.",
1188
+ "markdownDescription": "Contains input options for Editable Regions and the Content Editor."
1189
+ },
1190
+ "_enabled_editors": {
1191
+ "description": "Set a preferred editor and/or disable the others. The first value sets which editor opens by default, and the following values specify which editors are accessible.",
1192
+ "items": {
1193
+ "$ref": "#/definitions/EditorKey"
1194
+ },
1195
+ "markdownDescription": "Set a preferred editor and/or disable the others. The first value sets which editor opens by\ndefault, and the following values specify which editors are accessible.",
1196
+ "type": "array"
1197
+ },
1198
+ "_inputs": {
1199
+ "additionalProperties": {
1200
+ "$ref": "#/definitions/Input"
1201
+ },
1202
+ "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1203
+ "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1204
+ "type": "object"
1205
+ },
1206
+ "_options": {
1207
+ "additionalProperties": {
1208
+ "additionalProperties": {},
1209
+ "type": "object"
1210
+ },
1211
+ "description": "[DEPRECATED] Now part of _inputs.*.options.",
1212
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.options.",
1213
+ "type": "object"
1214
+ },
1215
+ "_select_data": {
1216
+ "additionalProperties": {
1217
+ "$ref": "#/definitions/SelectValues"
1218
+ },
1219
+ "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1220
+ "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1221
+ "type": "object"
1222
+ },
1223
+ "_structures": {
1224
+ "additionalProperties": {
1225
+ "$ref": "#/definitions/Structure"
1226
+ },
1227
+ "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.",
1228
+ "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.",
1229
+ "type": "object"
1230
+ },
1231
+ "glob": {
1232
+ "anyOf": [
1233
+ {
1234
+ "type": "string"
1235
+ },
1236
+ {
1237
+ "items": {
1238
+ "type": "string"
1239
+ },
1240
+ "type": "array"
1241
+ }
1242
+ ],
1243
+ "description": "The glob pattern(s) targeting a path to one or more files.",
1244
+ "markdownDescription": "The glob pattern(s) targeting a path to one or more files."
1245
+ }
1246
+ },
1247
+ "required": [
1248
+ "glob"
1249
+ ],
1250
+ "type": "object"
1251
+ },
1168
1252
  "FileInput": {
1169
1253
  "additionalProperties": false,
1170
1254
  "properties": {
@@ -1437,6 +1521,21 @@
1437
1521
  "description": "Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.",
1438
1522
  "markdownDescription": "Controls which files are displayed in the collection list. Does not change which files are\nassigned to this collection."
1439
1523
  },
1524
+ "glob": {
1525
+ "anyOf": [
1526
+ {
1527
+ "type": "string"
1528
+ },
1529
+ {
1530
+ "items": {
1531
+ "type": "string"
1532
+ },
1533
+ "type": "array"
1534
+ }
1535
+ ],
1536
+ "description": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.",
1537
+ "markdownDescription": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`."
1538
+ },
1440
1539
  "icon": {
1441
1540
  "$ref": "#/definitions/Icon",
1442
1541
  "description": "Sets an icon to use alongside references to this collection.",
@@ -1463,8 +1562,8 @@
1463
1562
  "type": "boolean"
1464
1563
  },
1465
1564
  "path": {
1466
- "description": "The top-most folder where the files in this collection are stored. It is relative to source. Each collection must have a unique path.",
1467
- "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.\nEach collection must have a unique path.",
1565
+ "description": "The top-most folder where the files in this collection are stored. It is relative to source.",
1566
+ "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
1468
1567
  "type": "string"
1469
1568
  },
1470
1569
  "preview": {
@@ -1648,6 +1747,14 @@
1648
1747
  "description": "Contains settings for the default editor actions on your site.",
1649
1748
  "markdownDescription": "Contains settings for the default editor actions on your site."
1650
1749
  },
1750
+ "file_config": {
1751
+ "additionalProperties": {
1752
+ "$ref": "#/definitions/FileConfigEntry"
1753
+ },
1754
+ "description": "Provides scope to configure at a file level, without adding configuration to files.",
1755
+ "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
1756
+ "type": "object"
1757
+ },
1651
1758
  "generator": {
1652
1759
  "additionalProperties": false,
1653
1760
  "description": "Contains settings for various Markdown engines.",
@@ -5461,7 +5568,7 @@
5461
5568
  },
5462
5569
  "uploads_use_relative_path": {
5463
5570
  "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
5464
- "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
5571
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
5465
5572
  "type": "boolean"
5466
5573
  }
5467
5574
  },
@@ -6064,7 +6171,7 @@
6064
6171
  },
6065
6172
  "uploads_use_relative_path": {
6066
6173
  "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
6067
- "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
6174
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
6068
6175
  "type": "boolean"
6069
6176
  }
6070
6177
  },
@@ -1165,6 +1165,90 @@
1165
1165
  ],
1166
1166
  "type": "string"
1167
1167
  },
1168
+ "FileConfigEntry": {
1169
+ "additionalProperties": false,
1170
+ "properties": {
1171
+ "_array_structures": {
1172
+ "additionalProperties": {},
1173
+ "description": "[DEPRECATED] Now known as _structures.",
1174
+ "markdownDescription": "[DEPRECATED] Now known as _structures.",
1175
+ "type": "object"
1176
+ },
1177
+ "_comments": {
1178
+ "additionalProperties": {
1179
+ "type": "string"
1180
+ },
1181
+ "description": "[DEPRECATED] Now part of _inputs.*.comment.",
1182
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.comment.",
1183
+ "type": "object"
1184
+ },
1185
+ "_editables": {
1186
+ "$ref": "#/definitions/Editables",
1187
+ "description": "Contains input options for Editable Regions and the Content Editor.",
1188
+ "markdownDescription": "Contains input options for Editable Regions and the Content Editor."
1189
+ },
1190
+ "_enabled_editors": {
1191
+ "description": "Set a preferred editor and/or disable the others. The first value sets which editor opens by default, and the following values specify which editors are accessible.",
1192
+ "items": {
1193
+ "$ref": "#/definitions/EditorKey"
1194
+ },
1195
+ "markdownDescription": "Set a preferred editor and/or disable the others. The first value sets which editor opens by\ndefault, and the following values specify which editors are accessible.",
1196
+ "type": "array"
1197
+ },
1198
+ "_inputs": {
1199
+ "additionalProperties": {
1200
+ "$ref": "#/definitions/Input"
1201
+ },
1202
+ "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1203
+ "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
1204
+ "type": "object"
1205
+ },
1206
+ "_options": {
1207
+ "additionalProperties": {
1208
+ "additionalProperties": {},
1209
+ "type": "object"
1210
+ },
1211
+ "description": "[DEPRECATED] Now part of _inputs.*.options.",
1212
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.options.",
1213
+ "type": "object"
1214
+ },
1215
+ "_select_data": {
1216
+ "additionalProperties": {
1217
+ "$ref": "#/definitions/SelectValues"
1218
+ },
1219
+ "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
1220
+ "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
1221
+ "type": "object"
1222
+ },
1223
+ "_structures": {
1224
+ "additionalProperties": {
1225
+ "$ref": "#/definitions/Structure"
1226
+ },
1227
+ "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.",
1228
+ "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.",
1229
+ "type": "object"
1230
+ },
1231
+ "glob": {
1232
+ "anyOf": [
1233
+ {
1234
+ "type": "string"
1235
+ },
1236
+ {
1237
+ "items": {
1238
+ "type": "string"
1239
+ },
1240
+ "type": "array"
1241
+ }
1242
+ ],
1243
+ "description": "The glob pattern(s) targeting a path to one or more files.",
1244
+ "markdownDescription": "The glob pattern(s) targeting a path to one or more files."
1245
+ }
1246
+ },
1247
+ "required": [
1248
+ "glob"
1249
+ ],
1250
+ "type": "object"
1251
+ },
1168
1252
  "FileInput": {
1169
1253
  "additionalProperties": false,
1170
1254
  "properties": {
@@ -4069,6 +4153,21 @@
4069
4153
  "description": "Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.",
4070
4154
  "markdownDescription": "Controls which files are displayed in the collection list. Does not change which files are\nassigned to this collection."
4071
4155
  },
4156
+ "glob": {
4157
+ "anyOf": [
4158
+ {
4159
+ "type": "string"
4160
+ },
4161
+ {
4162
+ "items": {
4163
+ "type": "string"
4164
+ },
4165
+ "type": "array"
4166
+ }
4167
+ ],
4168
+ "description": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.",
4169
+ "markdownDescription": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`."
4170
+ },
4072
4171
  "icon": {
4073
4172
  "$ref": "#/definitions/Icon",
4074
4173
  "description": "Sets an icon to use alongside references to this collection.",
@@ -4090,8 +4189,8 @@
4090
4189
  "type": "boolean"
4091
4190
  },
4092
4191
  "path": {
4093
- "description": "The top-most folder where the files in this collection are stored. It is relative to source. Each collection must have a unique path.",
4094
- "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.\nEach collection must have a unique path.",
4192
+ "description": "The top-most folder where the files in this collection are stored. It is relative to source.",
4193
+ "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
4095
4194
  "type": "string"
4096
4195
  },
4097
4196
  "preview": {
@@ -4166,6 +4265,14 @@
4166
4265
  "description": "Contains settings for the default editor actions on your site.",
4167
4266
  "markdownDescription": "Contains settings for the default editor actions on your site."
4168
4267
  },
4268
+ "file_config": {
4269
+ "additionalProperties": {
4270
+ "$ref": "#/definitions/FileConfigEntry"
4271
+ },
4272
+ "description": "Provides scope to configure at a file level, without adding configuration to files.",
4273
+ "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
4274
+ "type": "object"
4275
+ },
4169
4276
  "generator": {
4170
4277
  "additionalProperties": false,
4171
4278
  "description": "Contains settings for various Markdown engines.",
@@ -5453,7 +5560,7 @@
5453
5560
  },
5454
5561
  "uploads_use_relative_path": {
5455
5562
  "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 uploaded to.",
5563
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
5457
5564
  "type": "boolean"
5458
5565
  }
5459
5566
  },
@@ -6056,7 +6163,7 @@
6056
6163
  },
6057
6164
  "uploads_use_relative_path": {
6058
6165
  "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 uploaded to.",
6166
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
6060
6167
  "type": "boolean"
6061
6168
  }
6062
6169
  },
@@ -853,6 +853,21 @@
853
853
  "description": "Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.",
854
854
  "markdownDescription": "Controls which files are displayed in the collection list. Does not change which files are\nassigned to this collection."
855
855
  },
856
+ "glob": {
857
+ "anyOf": [
858
+ {
859
+ "type": "string"
860
+ },
861
+ {
862
+ "items": {
863
+ "type": "string"
864
+ },
865
+ "type": "array"
866
+ }
867
+ ],
868
+ "description": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.",
869
+ "markdownDescription": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`."
870
+ },
856
871
  "icon": {
857
872
  "$ref": "#/definitions/Icon",
858
873
  "description": "Sets an icon to use alongside references to this collection.",
@@ -887,8 +902,8 @@
887
902
  "type": "string"
888
903
  },
889
904
  "path": {
890
- "description": "The top-most folder where the files in this collection are stored. It is relative to source. Each collection must have a unique path.",
891
- "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.\nEach collection must have a unique path.",
905
+ "description": "The top-most folder where the files in this collection are stored. It is relative to source.",
906
+ "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
892
907
  "type": "string"
893
908
  },
894
909
  "preview": {
@@ -1434,6 +1449,14 @@
1434
1449
  "description": "Contains settings for the default editor actions on your site.",
1435
1450
  "markdownDescription": "Contains settings for the default editor actions on your site."
1436
1451
  },
1452
+ "file_config": {
1453
+ "additionalProperties": {
1454
+ "$ref": "#/definitions/FileConfigEntry"
1455
+ },
1456
+ "description": "Provides scope to configure at a file level, without adding configuration to files.",
1457
+ "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
1458
+ "type": "object"
1459
+ },
1437
1460
  "generator": {
1438
1461
  "additionalProperties": false,
1439
1462
  "description": "Contains settings for various Markdown engines.",
@@ -1819,6 +1842,21 @@
1819
1842
  "description": "Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.",
1820
1843
  "markdownDescription": "Controls which files are displayed in the collection list. Does not change which files are\nassigned to this collection."
1821
1844
  },
1845
+ "glob": {
1846
+ "anyOf": [
1847
+ {
1848
+ "type": "string"
1849
+ },
1850
+ {
1851
+ "items": {
1852
+ "type": "string"
1853
+ },
1854
+ "type": "array"
1855
+ }
1856
+ ],
1857
+ "description": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.",
1858
+ "markdownDescription": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`."
1859
+ },
1822
1860
  "icon": {
1823
1861
  "$ref": "#/definitions/Icon",
1824
1862
  "description": "Sets an icon to use alongside references to this collection.",
@@ -1840,8 +1878,8 @@
1840
1878
  "type": "boolean"
1841
1879
  },
1842
1880
  "path": {
1843
- "description": "The top-most folder where the files in this collection are stored. It is relative to source. Each collection must have a unique path.",
1844
- "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.\nEach collection must have a unique path.",
1881
+ "description": "The top-most folder where the files in this collection are stored. It is relative to source.",
1882
+ "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
1845
1883
  "type": "string"
1846
1884
  },
1847
1885
  "preview": {
@@ -1916,6 +1954,14 @@
1916
1954
  "description": "Contains settings for the default editor actions on your site.",
1917
1955
  "markdownDescription": "Contains settings for the default editor actions on your site."
1918
1956
  },
1957
+ "file_config": {
1958
+ "additionalProperties": {
1959
+ "$ref": "#/definitions/FileConfigEntry"
1960
+ },
1961
+ "description": "Provides scope to configure at a file level, without adding configuration to files.",
1962
+ "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
1963
+ "type": "object"
1964
+ },
1919
1965
  "generator": {
1920
1966
  "additionalProperties": false,
1921
1967
  "description": "Contains settings for various Markdown engines.",
@@ -2028,6 +2074,90 @@
2028
2074
  ],
2029
2075
  "type": "string"
2030
2076
  },
2077
+ "FileConfigEntry": {
2078
+ "additionalProperties": false,
2079
+ "properties": {
2080
+ "_array_structures": {
2081
+ "additionalProperties": {},
2082
+ "description": "[DEPRECATED] Now known as _structures.",
2083
+ "markdownDescription": "[DEPRECATED] Now known as _structures.",
2084
+ "type": "object"
2085
+ },
2086
+ "_comments": {
2087
+ "additionalProperties": {
2088
+ "type": "string"
2089
+ },
2090
+ "description": "[DEPRECATED] Now part of _inputs.*.comment.",
2091
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.comment.",
2092
+ "type": "object"
2093
+ },
2094
+ "_editables": {
2095
+ "$ref": "#/definitions/Editables",
2096
+ "description": "Contains input options for Editable Regions and the Content Editor.",
2097
+ "markdownDescription": "Contains input options for Editable Regions and the Content Editor."
2098
+ },
2099
+ "_enabled_editors": {
2100
+ "description": "Set a preferred editor and/or disable the others. The first value sets which editor opens by default, and the following values specify which editors are accessible.",
2101
+ "items": {
2102
+ "$ref": "#/definitions/EditorKey"
2103
+ },
2104
+ "markdownDescription": "Set a preferred editor and/or disable the others. The first value sets which editor opens by\ndefault, and the following values specify which editors are accessible.",
2105
+ "type": "array"
2106
+ },
2107
+ "_inputs": {
2108
+ "additionalProperties": {
2109
+ "$ref": "#/definitions/Input"
2110
+ },
2111
+ "description": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
2112
+ "markdownDescription": "Controls the behavior and appearance of your inputs in all data editing interfaces.",
2113
+ "type": "object"
2114
+ },
2115
+ "_options": {
2116
+ "additionalProperties": {
2117
+ "additionalProperties": {},
2118
+ "type": "object"
2119
+ },
2120
+ "description": "[DEPRECATED] Now part of _inputs.*.options.",
2121
+ "markdownDescription": "[DEPRECATED] Now part of _inputs.*.options.",
2122
+ "type": "object"
2123
+ },
2124
+ "_select_data": {
2125
+ "additionalProperties": {
2126
+ "$ref": "#/definitions/SelectValues"
2127
+ },
2128
+ "description": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.",
2129
+ "markdownDescription": "Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and\n_Multiselect_ inputs.",
2130
+ "type": "object"
2131
+ },
2132
+ "_structures": {
2133
+ "additionalProperties": {
2134
+ "$ref": "#/definitions/Structure"
2135
+ },
2136
+ "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.",
2137
+ "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.",
2138
+ "type": "object"
2139
+ },
2140
+ "glob": {
2141
+ "anyOf": [
2142
+ {
2143
+ "type": "string"
2144
+ },
2145
+ {
2146
+ "items": {
2147
+ "type": "string"
2148
+ },
2149
+ "type": "array"
2150
+ }
2151
+ ],
2152
+ "description": "The glob pattern(s) targeting a path to one or more files.",
2153
+ "markdownDescription": "The glob pattern(s) targeting a path to one or more files."
2154
+ }
2155
+ },
2156
+ "required": [
2157
+ "glob"
2158
+ ],
2159
+ "type": "object"
2160
+ },
2031
2161
  "FileInput": {
2032
2162
  "additionalProperties": false,
2033
2163
  "properties": {
@@ -2300,6 +2430,21 @@
2300
2430
  "description": "Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.",
2301
2431
  "markdownDescription": "Controls which files are displayed in the collection list. Does not change which files are\nassigned to this collection."
2302
2432
  },
2433
+ "glob": {
2434
+ "anyOf": [
2435
+ {
2436
+ "type": "string"
2437
+ },
2438
+ {
2439
+ "items": {
2440
+ "type": "string"
2441
+ },
2442
+ "type": "array"
2443
+ }
2444
+ ],
2445
+ "description": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.",
2446
+ "markdownDescription": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`."
2447
+ },
2303
2448
  "icon": {
2304
2449
  "$ref": "#/definitions/Icon",
2305
2450
  "description": "Sets an icon to use alongside references to this collection.",
@@ -2326,8 +2471,8 @@
2326
2471
  "type": "boolean"
2327
2472
  },
2328
2473
  "path": {
2329
- "description": "The top-most folder where the files in this collection are stored. It is relative to source. Each collection must have a unique path.",
2330
- "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.\nEach collection must have a unique path.",
2474
+ "description": "The top-most folder where the files in this collection are stored. It is relative to source.",
2475
+ "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
2331
2476
  "type": "string"
2332
2477
  },
2333
2478
  "preview": {
@@ -2511,6 +2656,14 @@
2511
2656
  "description": "Contains settings for the default editor actions on your site.",
2512
2657
  "markdownDescription": "Contains settings for the default editor actions on your site."
2513
2658
  },
2659
+ "file_config": {
2660
+ "additionalProperties": {
2661
+ "$ref": "#/definitions/FileConfigEntry"
2662
+ },
2663
+ "description": "Provides scope to configure at a file level, without adding configuration to files.",
2664
+ "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
2665
+ "type": "object"
2666
+ },
2514
2667
  "generator": {
2515
2668
  "additionalProperties": false,
2516
2669
  "description": "Contains settings for various Markdown engines.",
@@ -5340,6 +5493,21 @@
5340
5493
  "description": "Controls which files are displayed in the collection list. Does not change which files are assigned to this collection.",
5341
5494
  "markdownDescription": "Controls which files are displayed in the collection list. Does not change which files are\nassigned to this collection."
5342
5495
  },
5496
+ "glob": {
5497
+ "anyOf": [
5498
+ {
5499
+ "type": "string"
5500
+ },
5501
+ {
5502
+ "items": {
5503
+ "type": "string"
5504
+ },
5505
+ "type": "array"
5506
+ }
5507
+ ],
5508
+ "description": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.",
5509
+ "markdownDescription": "Glob pattern(s) to include or exclude files from this collection. It is relative to `path`."
5510
+ },
5343
5511
  "icon": {
5344
5512
  "$ref": "#/definitions/Icon",
5345
5513
  "description": "Sets an icon to use alongside references to this collection.",
@@ -5361,8 +5529,8 @@
5361
5529
  "type": "boolean"
5362
5530
  },
5363
5531
  "path": {
5364
- "description": "The top-most folder where the files in this collection are stored. It is relative to source. Each collection must have a unique path.",
5365
- "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.\nEach collection must have a unique path.",
5532
+ "description": "The top-most folder where the files in this collection are stored. It is relative to source.",
5533
+ "markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
5366
5534
  "type": "string"
5367
5535
  },
5368
5536
  "preview": {
@@ -5437,6 +5605,14 @@
5437
5605
  "description": "Contains settings for the default editor actions on your site.",
5438
5606
  "markdownDescription": "Contains settings for the default editor actions on your site."
5439
5607
  },
5608
+ "file_config": {
5609
+ "additionalProperties": {
5610
+ "$ref": "#/definitions/FileConfigEntry"
5611
+ },
5612
+ "description": "Provides scope to configure at a file level, without adding configuration to files.",
5613
+ "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
5614
+ "type": "object"
5615
+ },
5440
5616
  "generator": {
5441
5617
  "additionalProperties": false,
5442
5618
  "description": "Contains settings for various Markdown engines.",
@@ -6724,7 +6900,7 @@
6724
6900
  },
6725
6901
  "uploads_use_relative_path": {
6726
6902
  "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
6727
- "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
6903
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
6728
6904
  "type": "boolean"
6729
6905
  }
6730
6906
  },
@@ -7327,7 +7503,7 @@
7327
7503
  },
7328
7504
  "uploads_use_relative_path": {
7329
7505
  "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
7330
- "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
7506
+ "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
7331
7507
  "type": "boolean"
7332
7508
  }
7333
7509
  },
@@ -8626,6 +8802,8 @@
8626
8802
  "nuxtjs",
8627
8803
  "sphinx",
8628
8804
  "static",
8805
+ "other",
8806
+ "legacy",
8629
8807
  "unknown"
8630
8808
  ],
8631
8809
  "type": "string"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cloudcannon/configuration-types",
3
- "version": "0.0.5",
3
+ "version": "0.0.7",
4
4
  "description": "Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.",
5
5
  "author": "CloudCannon <support@cloudcannon.com>",
6
6
  "license": "MIT",
package/src/index.d.ts CHANGED
@@ -44,8 +44,6 @@ export interface SnippetConfig extends ReducedCascade, Previewable, PickerPrevie
44
44
  params?: Record<string, any>; // TODO: use ParserConfig from @cloudcannon/scrap-booker.
45
45
  }
46
46
 
47
- type SnippetImportKey = keyof typeof Scrapbooker.defaults;
48
-
49
47
  interface SnippetsImport<T> {
50
48
  /**
51
49
  * The list of excluded snippets. If unset, all snippets are excluded unless defined in `include`.
@@ -791,12 +789,12 @@ export interface ObjectInputOptions extends BaseInputOptions<EmptyTypeObject> {
791
789
  * Allows you to group the inputs inside this object together without changing the data structure.
792
790
  */
793
791
  groups?: ObjectInputGroup[];
794
-
792
+
795
793
  /**
796
794
  * Controls which order input groups and ungrouped inputs appear in.
797
795
  */
798
796
  place_groups_below?: boolean;
799
-
797
+
800
798
  /**
801
799
  * Controls whether or not labels on mutable object entries are formatted.
802
800
  */
@@ -883,7 +881,8 @@ export interface ReducedPaths {
883
881
  */
884
882
  dam_static?: string;
885
883
  /**
886
- * When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.
884
+ * When set to true, CloudCannon will reference files relative to the path of the file they were
885
+ * uploaded to.
887
886
  */
888
887
  uploads_use_relative_path?: boolean;
889
888
  }
@@ -1159,9 +1158,12 @@ export interface Create extends ReducedCascade {
1159
1158
  export interface CollectionConfig extends Cascade, Previewable {
1160
1159
  /**
1161
1160
  * The top-most folder where the files in this collection are stored. It is relative to source.
1162
- * Each collection must have a unique path.
1163
1161
  */
1164
1162
  path?: string;
1163
+ /**
1164
+ * Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.
1165
+ */
1166
+ glob?: string | string[];
1165
1167
  /**
1166
1168
  * Whether or not files in this collection produce files in the build output.
1167
1169
  */
@@ -1389,6 +1391,13 @@ export interface DataConfigEntry {
1389
1391
  parser?: 'csv' | 'front-matter' | 'json' | 'properties' | 'toml' | 'yaml';
1390
1392
  }
1391
1393
 
1394
+ export interface FileConfigEntry extends Cascade {
1395
+ /**
1396
+ * The glob pattern(s) targeting a path to one or more files.
1397
+ */
1398
+ glob: string | string[];
1399
+ }
1400
+
1392
1401
  export interface Editor {
1393
1402
  /**
1394
1403
  * The URL used for the dashboard screenshot, and where the editor opens to when clicking the
@@ -1460,6 +1469,8 @@ export type SsgKey =
1460
1469
  | 'nuxtjs'
1461
1470
  | 'sphinx'
1462
1471
  | 'static'
1472
+ | 'other'
1473
+ | 'legacy'
1463
1474
  | 'unknown';
1464
1475
 
1465
1476
  export interface DefaultConfiguration extends Cascade, WithSnippets {
@@ -1496,6 +1507,10 @@ export interface DefaultConfiguration extends Cascade, WithSnippets {
1496
1507
  * Controls what data sets are available to populate select and multiselect inputs.
1497
1508
  */
1498
1509
  data_config?: Record<string, DataConfigEntry>;
1510
+ /**
1511
+ * Provides scope to configure at a file level, without adding configuration to files.
1512
+ */
1513
+ file_config?: Record<string, FileConfigEntry>;
1499
1514
  /**
1500
1515
  * Contains settings for the default editor actions on your site.
1501
1516
  */
@@ -1672,7 +1687,12 @@ interface WithIntegrationOutput {
1672
1687
 
1673
1688
  export interface DefaultIntegrationOutput extends DefaultConfiguration, WithIntegrationOutput {}
1674
1689
  export interface HugoIntegrationOutput extends HugoConfiguration, WithIntegrationOutput {}
1675
- export interface JekyllIntegrationOutput extends JekyllConfiguration, WithIntegrationOutput {}
1690
+ export interface JekyllIntegrationOutput extends JekyllConfiguration, WithIntegrationOutput {
1691
+ /**
1692
+ * @deprecated Do not use.
1693
+ */
1694
+ defaults: any;
1695
+ }
1676
1696
  export interface EleventyIntegrationOutput extends EleventyConfiguration, WithIntegrationOutput {}
1677
1697
 
1678
1698
  export type IntegrationOutput =