@cloudcannon/configuration-types 0.0.11 → 0.0.13
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 +10 -5
- package/build/cloudcannon-config-hugo.json +10 -5
- package/build/cloudcannon-config-jekyll.json +10 -5
- package/build/cloudcannon-config-reader.json +12 -7
- package/build/cloudcannon-config.json +12 -7
- package/package.json +1 -1
- package/src/configuration.d.ts +10 -5
|
@@ -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.",
|
|
@@ -7897,6 +7897,11 @@
|
|
|
7897
7897
|
"description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
|
|
7898
7898
|
"markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
|
|
7899
7899
|
},
|
|
7900
|
+
"icon": {
|
|
7901
|
+
"$ref": "#/definitions/Icon",
|
|
7902
|
+
"description": "Icon shown beside the input.",
|
|
7903
|
+
"markdownDescription": "Icon shown beside the input."
|
|
7904
|
+
},
|
|
7900
7905
|
"placeholder": {
|
|
7901
7906
|
"description": "Text shown when this input has no value.",
|
|
7902
7907
|
"markdownDescription": "Text shown when this input has no value.",
|
|
@@ -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.",
|
|
@@ -7899,6 +7899,11 @@
|
|
|
7899
7899
|
"description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
|
|
7900
7900
|
"markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
|
|
7901
7901
|
},
|
|
7902
|
+
"icon": {
|
|
7903
|
+
"$ref": "#/definitions/Icon",
|
|
7904
|
+
"description": "Icon shown beside the input.",
|
|
7905
|
+
"markdownDescription": "Icon shown beside the input."
|
|
7906
|
+
},
|
|
7902
7907
|
"placeholder": {
|
|
7903
7908
|
"description": "Text shown when this input has no value.",
|
|
7904
7909
|
"markdownDescription": "Text shown when this input has no value.",
|
|
@@ -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.",
|
|
@@ -7892,6 +7892,11 @@
|
|
|
7892
7892
|
"description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
|
|
7893
7893
|
"markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
|
|
7894
7894
|
},
|
|
7895
|
+
"icon": {
|
|
7896
|
+
"$ref": "#/definitions/Icon",
|
|
7897
|
+
"description": "Icon shown beside the input.",
|
|
7898
|
+
"markdownDescription": "Icon shown beside the input."
|
|
7899
|
+
},
|
|
7895
7900
|
"placeholder": {
|
|
7896
7901
|
"description": "Text shown when this input has no value.",
|
|
7897
7902
|
"markdownDescription": "Text shown when this input has no value.",
|
|
@@ -5889,6 +5889,11 @@
|
|
|
5889
5889
|
"markdownDescription": "Prevents users from renaming, moving and deleting files in the collection file list if true.",
|
|
5890
5890
|
"type": "boolean"
|
|
5891
5891
|
},
|
|
5892
|
+
"disable_url": {
|
|
5893
|
+
"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.",
|
|
5894
|
+
"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.",
|
|
5895
|
+
"type": "boolean"
|
|
5896
|
+
},
|
|
5892
5897
|
"documentation": {
|
|
5893
5898
|
"$ref": "#/definitions/Documentation",
|
|
5894
5899
|
"description": "Provides a custom link for documentation for editors shown above the collection file list.",
|
|
@@ -5936,11 +5941,6 @@
|
|
|
5936
5941
|
"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
5942
|
"type": "string"
|
|
5938
5943
|
},
|
|
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
5944
|
"parser": {
|
|
5945
5945
|
"description": "Overrides the format files are read. Detected automatically from file extension if unset.",
|
|
5946
5946
|
"enum": [
|
|
@@ -6001,8 +6001,8 @@
|
|
|
6001
6001
|
"type": "array"
|
|
6002
6002
|
},
|
|
6003
6003
|
"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 ''",
|
|
6004
|
+
"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.",
|
|
6005
|
+
"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
6006
|
"type": "string"
|
|
6007
6007
|
}
|
|
6008
6008
|
},
|
|
@@ -7938,6 +7938,11 @@
|
|
|
7938
7938
|
"description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
|
|
7939
7939
|
"markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
|
|
7940
7940
|
},
|
|
7941
|
+
"icon": {
|
|
7942
|
+
"$ref": "#/definitions/Icon",
|
|
7943
|
+
"description": "Icon shown beside the input.",
|
|
7944
|
+
"markdownDescription": "Icon shown beside the input."
|
|
7945
|
+
},
|
|
7941
7946
|
"placeholder": {
|
|
7942
7947
|
"description": "Text shown when this input has no value.",
|
|
7943
7948
|
"markdownDescription": "Text shown when this input has no value.",
|
|
@@ -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
|
},
|
|
@@ -7790,6 +7790,11 @@
|
|
|
7790
7790
|
"description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
|
|
7791
7791
|
"markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
|
|
7792
7792
|
},
|
|
7793
|
+
"icon": {
|
|
7794
|
+
"$ref": "#/definitions/Icon",
|
|
7795
|
+
"description": "Icon shown beside the input.",
|
|
7796
|
+
"markdownDescription": "Icon shown beside the input."
|
|
7797
|
+
},
|
|
7793
7798
|
"placeholder": {
|
|
7794
7799
|
"description": "Text shown when this input has no value.",
|
|
7795
7800
|
"markdownDescription": "Text shown when this input has no value.",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloudcannon/configuration-types",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.13",
|
|
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
|
@@ -629,6 +629,10 @@ export interface TextInputOptions extends BaseInputOptions {
|
|
|
629
629
|
* Text shown when this input has no value.
|
|
630
630
|
*/
|
|
631
631
|
placeholder?: string;
|
|
632
|
+
/**
|
|
633
|
+
* Icon shown beside the input.
|
|
634
|
+
*/
|
|
635
|
+
icon?: Icon;
|
|
632
636
|
}
|
|
633
637
|
|
|
634
638
|
export interface TextInput extends BaseInput<TextInputOptions> {
|
|
@@ -1223,15 +1227,16 @@ export interface CollectionConfig extends Cascade, Previewable {
|
|
|
1223
1227
|
* Glob pattern(s) to include or exclude files from this collection. It is relative to `path`.
|
|
1224
1228
|
*/
|
|
1225
1229
|
glob?: string[] | string;
|
|
1226
|
-
/**
|
|
1227
|
-
* Whether or not files in this collection produce files in the build output.
|
|
1228
|
-
*/
|
|
1229
|
-
output?: boolean;
|
|
1230
1230
|
/**
|
|
1231
1231
|
* Used to build the url field for items in the collection. Similar to permalink in many SSGs.
|
|
1232
|
-
* Defaults to ''
|
|
1232
|
+
* Defaults to '', in which case CloudCannon will attempt to guess the output URLs for each file.
|
|
1233
1233
|
*/
|
|
1234
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;
|
|
1235
1240
|
/**
|
|
1236
1241
|
* The display name of this collection. Used in headings and in the context menu for items in the
|
|
1237
1242
|
* collection. This is optional as CloudCannon auto-generates this from the collection key.
|