@cloudcannon/configuration-types 0.0.12 → 0.0.14
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.
- package/build/cloudcannon-config-eleventy.json +7 -6
- package/build/cloudcannon-config-hugo.json +7 -6
- package/build/cloudcannon-config-jekyll.json +7 -6
- package/build/cloudcannon-config-reader.json +9 -8
- package/build/cloudcannon-config.json +9 -8
- package/package.json +1 -1
- package/src/configuration.d.ts +7 -6
|
@@ -615,6 +615,11 @@
|
|
|
615
615
|
"markdownDescription": "Prevents users from renaming, moving and deleting files in the collection file list if true.",
|
|
616
616
|
"type": "boolean"
|
|
617
617
|
},
|
|
618
|
+
"disable_url": {
|
|
619
|
+
"description": "Prevents this collection from being assigned output URLs. Doing so will remove the Visual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
620
|
+
"markdownDescription": "Prevents this collection from being assigned output URLs. Doing so will remove the\nVisual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
621
|
+
"type": "boolean"
|
|
622
|
+
},
|
|
618
623
|
"documentation": {
|
|
619
624
|
"$ref": "#/definitions/Documentation",
|
|
620
625
|
"description": "Provides a custom link for documentation for editors shown above the collection file list.",
|
|
@@ -662,11 +667,6 @@
|
|
|
662
667
|
"markdownDescription": "Preview your unbuilt pages (e.g. drafts) to another page’s output URL. The Visual Editor will\nload that set preview URL and use the Data Bindings and Previews to render your new page\nwithout saving.\n\nFor example new_preview_url: /about/ will load the /about/ URL on new or unbuilt pages in the\nVisual Editor.",
|
|
663
668
|
"type": "string"
|
|
664
669
|
},
|
|
665
|
-
"output": {
|
|
666
|
-
"description": "Whether or not files in this collection produce files in the build output.",
|
|
667
|
-
"markdownDescription": "Whether or not files in this collection produce files in the build output.",
|
|
668
|
-
"type": "boolean"
|
|
669
|
-
},
|
|
670
670
|
"path": {
|
|
671
671
|
"description": "The top-most folder where the files in this collection are stored. It is relative to source.",
|
|
672
672
|
"markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
|
|
@@ -5835,7 +5835,8 @@
|
|
|
5835
5835
|
"description": "Changes the appearance and behavior of the input.",
|
|
5836
5836
|
"enum": [
|
|
5837
5837
|
"object",
|
|
5838
|
-
"mutable"
|
|
5838
|
+
"mutable",
|
|
5839
|
+
"tabbed"
|
|
5839
5840
|
],
|
|
5840
5841
|
"markdownDescription": "Changes the appearance and behavior of the input.",
|
|
5841
5842
|
"type": "string"
|
|
@@ -1592,6 +1592,11 @@
|
|
|
1592
1592
|
"markdownDescription": "Prevents users from renaming, moving and deleting files in the collection file list if true.",
|
|
1593
1593
|
"type": "boolean"
|
|
1594
1594
|
},
|
|
1595
|
+
"disable_url": {
|
|
1596
|
+
"description": "Prevents this collection from being assigned output URLs. Doing so will remove the Visual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
1597
|
+
"markdownDescription": "Prevents this collection from being assigned output URLs. Doing so will remove the\nVisual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
1598
|
+
"type": "boolean"
|
|
1599
|
+
},
|
|
1595
1600
|
"documentation": {
|
|
1596
1601
|
"$ref": "#/definitions/Documentation",
|
|
1597
1602
|
"description": "Provides a custom link for documentation for editors shown above the collection file list.",
|
|
@@ -1639,11 +1644,6 @@
|
|
|
1639
1644
|
"markdownDescription": "Preview your unbuilt pages (e.g. drafts) to another page’s output URL. The Visual Editor will\nload that set preview URL and use the Data Bindings and Previews to render your new page\nwithout saving.\n\nFor example new_preview_url: /about/ will load the /about/ URL on new or unbuilt pages in the\nVisual Editor.",
|
|
1640
1645
|
"type": "string"
|
|
1641
1646
|
},
|
|
1642
|
-
"output": {
|
|
1643
|
-
"description": "Whether or not files in this collection produce files in the build output.",
|
|
1644
|
-
"markdownDescription": "Whether or not files in this collection produce files in the build output.",
|
|
1645
|
-
"type": "boolean"
|
|
1646
|
-
},
|
|
1647
1647
|
"parse_branch_index": {
|
|
1648
1648
|
"description": "Controls whether branch index files (e.g. `_index.md`) are assigned to this collection or not. The \"pages\" collection defaults this to true, and false otherwise.",
|
|
1649
1649
|
"markdownDescription": "Controls whether branch index files (e.g. `_index.md`) are assigned to this collection or not.\nThe \"pages\" collection defaults this to true, and false otherwise.",
|
|
@@ -5837,7 +5837,8 @@
|
|
|
5837
5837
|
"description": "Changes the appearance and behavior of the input.",
|
|
5838
5838
|
"enum": [
|
|
5839
5839
|
"object",
|
|
5840
|
-
"mutable"
|
|
5840
|
+
"mutable",
|
|
5841
|
+
"tabbed"
|
|
5841
5842
|
],
|
|
5842
5843
|
"markdownDescription": "Changes the appearance and behavior of the input.",
|
|
5843
5844
|
"type": "string"
|
|
@@ -615,6 +615,11 @@
|
|
|
615
615
|
"markdownDescription": "Prevents users from renaming, moving and deleting files in the collection file list if true.",
|
|
616
616
|
"type": "boolean"
|
|
617
617
|
},
|
|
618
|
+
"disable_url": {
|
|
619
|
+
"description": "Prevents this collection from being assigned output URLs. Doing so will remove the Visual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
620
|
+
"markdownDescription": "Prevents this collection from being assigned output URLs. Doing so will remove the\nVisual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
621
|
+
"type": "boolean"
|
|
622
|
+
},
|
|
618
623
|
"documentation": {
|
|
619
624
|
"$ref": "#/definitions/Documentation",
|
|
620
625
|
"description": "Provides a custom link for documentation for editors shown above the collection file list.",
|
|
@@ -662,11 +667,6 @@
|
|
|
662
667
|
"markdownDescription": "Preview your unbuilt pages (e.g. drafts) to another page’s output URL. The Visual Editor will\nload that set preview URL and use the Data Bindings and Previews to render your new page\nwithout saving.\n\nFor example new_preview_url: /about/ will load the /about/ URL on new or unbuilt pages in the\nVisual Editor.",
|
|
663
668
|
"type": "string"
|
|
664
669
|
},
|
|
665
|
-
"output": {
|
|
666
|
-
"description": "Whether or not files in this collection produce files in the build output.",
|
|
667
|
-
"markdownDescription": "Whether or not files in this collection produce files in the build output.",
|
|
668
|
-
"type": "boolean"
|
|
669
|
-
},
|
|
670
670
|
"path": {
|
|
671
671
|
"description": "The top-most folder where the files in this collection are stored. It is relative to source.",
|
|
672
672
|
"markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
|
|
@@ -5830,7 +5830,8 @@
|
|
|
5830
5830
|
"description": "Changes the appearance and behavior of the input.",
|
|
5831
5831
|
"enum": [
|
|
5832
5832
|
"object",
|
|
5833
|
-
"mutable"
|
|
5833
|
+
"mutable",
|
|
5834
|
+
"tabbed"
|
|
5834
5835
|
],
|
|
5835
5836
|
"markdownDescription": "Changes the appearance and behavior of the input.",
|
|
5836
5837
|
"type": "string"
|
|
@@ -5451,7 +5451,8 @@
|
|
|
5451
5451
|
"description": "Changes the appearance and behavior of the input.",
|
|
5452
5452
|
"enum": [
|
|
5453
5453
|
"object",
|
|
5454
|
-
"mutable"
|
|
5454
|
+
"mutable",
|
|
5455
|
+
"tabbed"
|
|
5455
5456
|
],
|
|
5456
5457
|
"markdownDescription": "Changes the appearance and behavior of the input.",
|
|
5457
5458
|
"type": "string"
|
|
@@ -5889,6 +5890,11 @@
|
|
|
5889
5890
|
"markdownDescription": "Prevents users from renaming, moving and deleting files in the collection file list if true.",
|
|
5890
5891
|
"type": "boolean"
|
|
5891
5892
|
},
|
|
5893
|
+
"disable_url": {
|
|
5894
|
+
"description": "Prevents this collection from being assigned output URLs. Doing so will remove the Visual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
5895
|
+
"markdownDescription": "Prevents this collection from being assigned output URLs. Doing so will remove the\nVisual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
5896
|
+
"type": "boolean"
|
|
5897
|
+
},
|
|
5892
5898
|
"documentation": {
|
|
5893
5899
|
"$ref": "#/definitions/Documentation",
|
|
5894
5900
|
"description": "Provides a custom link for documentation for editors shown above the collection file list.",
|
|
@@ -5936,11 +5942,6 @@
|
|
|
5936
5942
|
"markdownDescription": "Preview your unbuilt pages (e.g. drafts) to another page’s output URL. The Visual Editor will\nload that set preview URL and use the Data Bindings and Previews to render your new page\nwithout saving.\n\nFor example new_preview_url: /about/ will load the /about/ URL on new or unbuilt pages in the\nVisual Editor.",
|
|
5937
5943
|
"type": "string"
|
|
5938
5944
|
},
|
|
5939
|
-
"output": {
|
|
5940
|
-
"description": "Whether or not files in this collection produce files in the build output.",
|
|
5941
|
-
"markdownDescription": "Whether or not files in this collection produce files in the build output.",
|
|
5942
|
-
"type": "boolean"
|
|
5943
|
-
},
|
|
5944
5945
|
"parser": {
|
|
5945
5946
|
"description": "Overrides the format files are read. Detected automatically from file extension if unset.",
|
|
5946
5947
|
"enum": [
|
|
@@ -6001,8 +6002,8 @@
|
|
|
6001
6002
|
"type": "array"
|
|
6002
6003
|
},
|
|
6003
6004
|
"url": {
|
|
6004
|
-
"description": "Used to build the url field for items in the collection. Similar to permalink in many SSGs. Defaults to ''",
|
|
6005
|
-
"markdownDescription": "Used to build the url field for items in the collection. Similar to permalink in many SSGs.\nDefaults to ''",
|
|
6005
|
+
"description": "Used to build the url field for items in the collection. Similar to permalink in many SSGs. Defaults to '', in which case CloudCannon will attempt to guess the output URLs for each file.",
|
|
6006
|
+
"markdownDescription": "Used to build the url field for items in the collection. Similar to permalink in many SSGs.\nDefaults to '', in which case CloudCannon will attempt to guess the output URLs for each file.",
|
|
6006
6007
|
"type": "string"
|
|
6007
6008
|
}
|
|
6008
6009
|
},
|
|
@@ -855,6 +855,11 @@
|
|
|
855
855
|
"markdownDescription": "Prevents users from renaming, moving and deleting files in the collection file list if true.",
|
|
856
856
|
"type": "boolean"
|
|
857
857
|
},
|
|
858
|
+
"disable_url": {
|
|
859
|
+
"description": "Prevents this collection from being assigned output URLs. Doing so will remove the Visual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
860
|
+
"markdownDescription": "Prevents this collection from being assigned output URLs. Doing so will remove the\nVisual Editor as a possible option, and hide any UI elements referring to the output URL for a file.",
|
|
861
|
+
"type": "boolean"
|
|
862
|
+
},
|
|
858
863
|
"documentation": {
|
|
859
864
|
"$ref": "#/definitions/Documentation",
|
|
860
865
|
"description": "Provides a custom link for documentation for editors shown above the collection file list.",
|
|
@@ -890,11 +895,6 @@
|
|
|
890
895
|
"markdownDescription": "Preview your unbuilt pages (e.g. drafts) to another page’s output URL. The Visual Editor will\nload that set preview URL and use the Data Bindings and Previews to render your new page\nwithout saving.\n\nFor example new_preview_url: /about/ will load the /about/ URL on new or unbuilt pages in the\nVisual Editor.",
|
|
891
896
|
"type": "string"
|
|
892
897
|
},
|
|
893
|
-
"output": {
|
|
894
|
-
"description": "Whether or not files in this collection produce files in the build output.",
|
|
895
|
-
"markdownDescription": "Whether or not files in this collection produce files in the build output.",
|
|
896
|
-
"type": "boolean"
|
|
897
|
-
},
|
|
898
898
|
"path": {
|
|
899
899
|
"description": "The top-most folder where the files in this collection are stored. It is relative to source.",
|
|
900
900
|
"markdownDescription": "The top-most folder where the files in this collection are stored. It is relative to source.",
|
|
@@ -937,8 +937,8 @@
|
|
|
937
937
|
"type": "array"
|
|
938
938
|
},
|
|
939
939
|
"url": {
|
|
940
|
-
"description": "Used to build the url field for items in the collection. Similar to permalink in many SSGs. Defaults to ''",
|
|
941
|
-
"markdownDescription": "Used to build the url field for items in the collection. Similar to permalink in many SSGs.\nDefaults to ''",
|
|
940
|
+
"description": "Used to build the url field for items in the collection. Similar to permalink in many SSGs. Defaults to '', in which case CloudCannon will attempt to guess the output URLs for each file.",
|
|
941
|
+
"markdownDescription": "Used to build the url field for items in the collection. Similar to permalink in many SSGs.\nDefaults to '', in which case CloudCannon will attempt to guess the output URLs for each file.",
|
|
942
942
|
"type": "string"
|
|
943
943
|
}
|
|
944
944
|
},
|
|
@@ -5728,7 +5728,8 @@
|
|
|
5728
5728
|
"description": "Changes the appearance and behavior of the input.",
|
|
5729
5729
|
"enum": [
|
|
5730
5730
|
"object",
|
|
5731
|
-
"mutable"
|
|
5731
|
+
"mutable",
|
|
5732
|
+
"tabbed"
|
|
5732
5733
|
],
|
|
5733
5734
|
"markdownDescription": "Changes the appearance and behavior of the input.",
|
|
5734
5735
|
"type": "string"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloudcannon/configuration-types",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.14",
|
|
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/configuration.d.ts
CHANGED
|
@@ -854,7 +854,7 @@ export interface ObjectInputOptions extends BaseInputOptions<EmptyTypeObject> {
|
|
|
854
854
|
/**
|
|
855
855
|
* Changes the appearance and behavior of the input.
|
|
856
856
|
*/
|
|
857
|
-
subtype?: 'object' | 'mutable';
|
|
857
|
+
subtype?: 'object' | 'mutable' | 'tabbed';
|
|
858
858
|
/**
|
|
859
859
|
* Contains options for the "mutable" subtype.
|
|
860
860
|
*/
|
|
@@ -1227,15 +1227,16 @@ export interface CollectionConfig extends Cascade, Previewable {
|
|
|
1227
1227
|
* Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.
|
|
1228
1228
|
*/
|
|
1229
1229
|
glob?: string[] | string;
|
|
1230
|
-
/**
|
|
1231
|
-
* Whether or not files in this collection produce files in the build output.
|
|
1232
|
-
*/
|
|
1233
|
-
output?: boolean;
|
|
1234
1230
|
/**
|
|
1235
1231
|
* Used to build the url field for items in the collection. Similar to permalink in many SSGs.
|
|
1236
|
-
* Defaults to ''
|
|
1232
|
+
* Defaults to '', in which case CloudCannon will attempt to guess the output URLs for each file.
|
|
1237
1233
|
*/
|
|
1238
1234
|
url?: string;
|
|
1235
|
+
/**
|
|
1236
|
+
* Prevents this collection from being assigned output URLs. Doing so will remove the
|
|
1237
|
+
* Visual Editor as a possible option, and hide any UI elements referring to the output URL for a file.
|
|
1238
|
+
*/
|
|
1239
|
+
disable_url?: boolean;
|
|
1239
1240
|
/**
|
|
1240
1241
|
* The display name of this collection. Used in headings and in the context menu for items in the
|
|
1241
1242
|
* collection. This is optional as CloudCannon auto-generates this from the collection key.
|