@cloudcannon/configuration-types 0.0.38 → 0.0.40

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.
@@ -131,37 +131,8 @@
131
131
  ],
132
132
  "markdownDescription": "This key defines the documentation link at the top of a _Collection browser_. Collection documentation is useful for assisting your team members."
133
133
  },
134
- "sort": {
135
- "description": "This key defines how CloudCannon sorts your Collection files when you first open your _Collection browser_.",
136
- "title": "Sort",
137
- "type": "object",
138
- "properties": {
139
- "key": {
140
- "description": "Defines what field contains the value to sort on inside each collection item's data.",
141
- "type": "string",
142
- "markdownDescription": "Defines what field contains the value to sort on inside each collection item's data."
143
- },
144
- "order": {
145
- "description": "Controls which sort values come first.",
146
- "default": "ascending",
147
- "type": "string",
148
- "enum": [
149
- "ascending",
150
- "descending",
151
- "asc",
152
- "desc"
153
- ],
154
- "markdownDescription": "Controls which sort values come first."
155
- }
156
- },
157
- "required": [
158
- "key"
159
- ],
160
- "additionalProperties": false,
161
- "markdownDescription": "This key defines how CloudCannon sorts your Collection files when you first open your _Collection browser_."
162
- },
163
134
  "sort_options": {
164
- "description": "This key defines the options for the Sort dropdown in a _Collection browser_.",
135
+ "description": "This key defines the options for the Sort dropdown in a _Collection browser_. The first option listed is used as the default sort.",
165
136
  "type": "array",
166
137
  "items": {
167
138
  "title": "SortOption",
@@ -197,7 +168,21 @@
197
168
  "additionalProperties": false,
198
169
  "markdownDescription": "A sort option for a Collection."
199
170
  },
200
- "markdownDescription": "This key defines the options for the Sort dropdown in a _Collection browser_."
171
+ "markdownDescription": "This key defines the options for the Sort dropdown in a _Collection browser_. The first option listed is used as the default sort."
172
+ },
173
+ "view_options": {
174
+ "uniqueItems": true,
175
+ "description": "This key defines the options for the View dropdown in a _Collection browser_. The first option listed is used as the default view.",
176
+ "type": "array",
177
+ "items": {
178
+ "type": "string",
179
+ "enum": [
180
+ "card",
181
+ "list",
182
+ "gallery"
183
+ ]
184
+ },
185
+ "markdownDescription": "This key defines the options for the View dropdown in a _Collection browser_. The first option listed is used as the default view."
201
186
  },
202
187
  "singular_name": {
203
188
  "description": "This key defines the singular noun for your Collection name. CloudCannon uses the singular noun in the _+ Add_ button in the top right of the _Collection browser_.",
@@ -4926,60 +4911,79 @@
4926
4911
  "description": "Controls the color of the icon.",
4927
4912
  "allOf": [
4928
4913
  {
4929
- "$ref": "#/definitions/PreviewEntry"
4914
+ "$ref": "#/definitions/PreviewEntries"
4930
4915
  }
4931
4916
  ],
4932
4917
  "markdownDescription": "Controls the color of the icon."
4933
4918
  },
4934
- "PreviewEntry": {
4935
- "id": "PreviewEntry",
4919
+ "PreviewEntries": {
4920
+ "id": "PreviewEntries",
4936
4921
  "anyOf": [
4937
4922
  {
4938
4923
  "type": "array",
4939
4924
  "items": {
4940
- "anyOf": [
4941
- {
4942
- "type": "object",
4943
- "properties": {
4944
- "key": {
4945
- "description": "The key used to access the value used for the preview.",
4946
- "type": "string",
4947
- "markdownDescription": "The key used to access the value used for the preview."
4948
- }
4949
- },
4950
- "required": [
4951
- "key"
4952
- ],
4953
- "additionalProperties": false
4954
- },
4955
- {
4956
- "type": "object",
4957
- "properties": {
4958
- "template": {
4959
- "description": "A template string containing various placeholders for the value used in the preview.",
4960
- "type": "string",
4961
- "markdownDescription": "A template string containing various placeholders for the value used in the preview."
4962
- }
4963
- },
4964
- "required": [
4965
- "template"
4966
- ],
4967
- "additionalProperties": false
4968
- },
4969
- {
4970
- "type": "string"
4971
- },
4972
- {
4973
- "type": "boolean"
4974
- }
4975
- ]
4925
+ "$ref": "#/definitions/PreviewEntry"
4976
4926
  }
4977
4927
  },
4978
4928
  {
4979
4929
  "type": "string"
4980
4930
  },
4981
4931
  {
4982
- "type": "boolean"
4932
+ "type": "boolean",
4933
+ "const": false
4934
+ }
4935
+ ]
4936
+ },
4937
+ "PreviewEntry": {
4938
+ "anyOf": [
4939
+ {
4940
+ "type": "object",
4941
+ "properties": {
4942
+ "key": {
4943
+ "description": "The key used to access the value used for the preview.",
4944
+ "type": "string",
4945
+ "markdownDescription": "The key used to access the value used for the preview."
4946
+ }
4947
+ },
4948
+ "required": [
4949
+ "key"
4950
+ ],
4951
+ "additionalProperties": false
4952
+ },
4953
+ {
4954
+ "type": "object",
4955
+ "properties": {
4956
+ "template": {
4957
+ "description": "A template string containing various placeholders for the value used in the preview.",
4958
+ "type": "string",
4959
+ "markdownDescription": "A template string containing various placeholders for the value used in the preview."
4960
+ }
4961
+ },
4962
+ "required": [
4963
+ "template"
4964
+ ],
4965
+ "additionalProperties": false
4966
+ },
4967
+ {
4968
+ "type": "object",
4969
+ "properties": {
4970
+ "text": {
4971
+ "description": "The raw text used as the value for the preview.",
4972
+ "type": "string",
4973
+ "markdownDescription": "The raw text used as the value for the preview."
4974
+ }
4975
+ },
4976
+ "required": [
4977
+ "text"
4978
+ ],
4979
+ "additionalProperties": false
4980
+ },
4981
+ {
4982
+ "type": "string"
4983
+ },
4984
+ {
4985
+ "type": "boolean",
4986
+ "const": false
4983
4987
  }
4984
4988
  ]
4985
4989
  },
@@ -4987,7 +4991,7 @@
4987
4991
  "description": "Controls the background color of the icon.",
4988
4992
  "allOf": [
4989
4993
  {
4990
- "$ref": "#/definitions/PreviewEntry"
4994
+ "$ref": "#/definitions/PreviewEntries"
4991
4995
  }
4992
4996
  ],
4993
4997
  "markdownDescription": "Controls the background color of the icon."
@@ -8200,7 +8204,7 @@
8200
8204
  "description": "Controls the supporting text shown per item.",
8201
8205
  "allOf": [
8202
8206
  {
8203
- "$ref": "#/definitions/PreviewEntry"
8207
+ "$ref": "#/definitions/PreviewEntries"
8204
8208
  }
8205
8209
  ],
8206
8210
  "markdownDescription": "Controls the supporting text shown per item."
@@ -8233,6 +8237,14 @@
8233
8237
  }
8234
8238
  ]
8235
8239
  },
8240
+ "tags": {
8241
+ "description": "Defines a list of tags.",
8242
+ "type": "array",
8243
+ "items": {
8244
+ "type": "string"
8245
+ },
8246
+ "markdownDescription": "Defines a list of tags."
8247
+ },
8236
8248
  "metadata": {
8237
8249
  "description": "Defines a list of items that can contain an image, icon, and text.",
8238
8250
  "type": "array",
@@ -8258,7 +8270,7 @@
8258
8270
  "description": "Controls the main text shown per item.",
8259
8271
  "allOf": [
8260
8272
  {
8261
- "$ref": "#/definitions/PreviewEntry"
8273
+ "$ref": "#/definitions/PreviewEntries"
8262
8274
  }
8263
8275
  ],
8264
8276
  "markdownDescription": "Controls the main text shown per item."
@@ -8267,7 +8279,7 @@
8267
8279
  "description": "Controls the image shown per item.",
8268
8280
  "allOf": [
8269
8281
  {
8270
- "$ref": "#/definitions/PreviewEntry"
8282
+ "$ref": "#/definitions/PreviewEntries"
8271
8283
  }
8272
8284
  ],
8273
8285
  "markdownDescription": "Controls the image shown per item."
@@ -8276,7 +8288,7 @@
8276
8288
  "description": "Controls the icon shown per item. Must result in a Material Symbol name.",
8277
8289
  "allOf": [
8278
8290
  {
8279
- "$ref": "#/definitions/PreviewEntry"
8291
+ "$ref": "#/definitions/PreviewEntries"
8280
8292
  }
8281
8293
  ],
8282
8294
  "markdownDescription": "Controls the icon shown per item. Must result in a Material Symbol name."
@@ -8381,7 +8393,7 @@
8381
8393
  "description": "Controls the background color gallery area.",
8382
8394
  "allOf": [
8383
8395
  {
8384
- "$ref": "#/definitions/PreviewEntry"
8396
+ "$ref": "#/definitions/PreviewEntries"
8385
8397
  }
8386
8398
  ],
8387
8399
  "markdownDescription": "Controls the background color gallery area."
@@ -8406,7 +8418,7 @@
8406
8418
  "description": "Controls the supporting text shown per item.",
8407
8419
  "allOf": [
8408
8420
  {
8409
- "$ref": "#/definitions/PreviewEntry"
8421
+ "$ref": "#/definitions/PreviewEntries"
8410
8422
  }
8411
8423
  ],
8412
8424
  "markdownDescription": "Controls the supporting text shown per item."
@@ -8439,6 +8451,14 @@
8439
8451
  }
8440
8452
  ]
8441
8453
  },
8454
+ "tags": {
8455
+ "description": "Defines a list of tags.",
8456
+ "type": "array",
8457
+ "items": {
8458
+ "type": "string"
8459
+ },
8460
+ "markdownDescription": "Defines a list of tags."
8461
+ },
8442
8462
  "metadata": {
8443
8463
  "description": "Defines a list of items that can contain an image, icon, and text.",
8444
8464
  "type": "array",
@@ -4501,60 +4501,79 @@
4501
4501
  "description": "Controls the color of the icon.",
4502
4502
  "allOf": [
4503
4503
  {
4504
- "$ref": "#/definitions/PreviewEntry"
4504
+ "$ref": "#/definitions/PreviewEntries"
4505
4505
  }
4506
4506
  ],
4507
4507
  "markdownDescription": "Controls the color of the icon."
4508
4508
  },
4509
- "PreviewEntry": {
4510
- "id": "PreviewEntry",
4509
+ "PreviewEntries": {
4510
+ "id": "PreviewEntries",
4511
4511
  "anyOf": [
4512
4512
  {
4513
4513
  "type": "array",
4514
4514
  "items": {
4515
- "anyOf": [
4516
- {
4517
- "type": "object",
4518
- "properties": {
4519
- "key": {
4520
- "description": "The key used to access the value used for the preview.",
4521
- "type": "string",
4522
- "markdownDescription": "The key used to access the value used for the preview."
4523
- }
4524
- },
4525
- "required": [
4526
- "key"
4527
- ],
4528
- "additionalProperties": false
4529
- },
4530
- {
4531
- "type": "object",
4532
- "properties": {
4533
- "template": {
4534
- "description": "A template string containing various placeholders for the value used in the preview.",
4535
- "type": "string",
4536
- "markdownDescription": "A template string containing various placeholders for the value used in the preview."
4537
- }
4538
- },
4539
- "required": [
4540
- "template"
4541
- ],
4542
- "additionalProperties": false
4543
- },
4544
- {
4545
- "type": "string"
4546
- },
4547
- {
4548
- "type": "boolean"
4549
- }
4550
- ]
4515
+ "$ref": "#/definitions/PreviewEntry"
4551
4516
  }
4552
4517
  },
4553
4518
  {
4554
4519
  "type": "string"
4555
4520
  },
4556
4521
  {
4557
- "type": "boolean"
4522
+ "type": "boolean",
4523
+ "const": false
4524
+ }
4525
+ ]
4526
+ },
4527
+ "PreviewEntry": {
4528
+ "anyOf": [
4529
+ {
4530
+ "type": "object",
4531
+ "properties": {
4532
+ "key": {
4533
+ "description": "The key used to access the value used for the preview.",
4534
+ "type": "string",
4535
+ "markdownDescription": "The key used to access the value used for the preview."
4536
+ }
4537
+ },
4538
+ "required": [
4539
+ "key"
4540
+ ],
4541
+ "additionalProperties": false
4542
+ },
4543
+ {
4544
+ "type": "object",
4545
+ "properties": {
4546
+ "template": {
4547
+ "description": "A template string containing various placeholders for the value used in the preview.",
4548
+ "type": "string",
4549
+ "markdownDescription": "A template string containing various placeholders for the value used in the preview."
4550
+ }
4551
+ },
4552
+ "required": [
4553
+ "template"
4554
+ ],
4555
+ "additionalProperties": false
4556
+ },
4557
+ {
4558
+ "type": "object",
4559
+ "properties": {
4560
+ "text": {
4561
+ "description": "The raw text used as the value for the preview.",
4562
+ "type": "string",
4563
+ "markdownDescription": "The raw text used as the value for the preview."
4564
+ }
4565
+ },
4566
+ "required": [
4567
+ "text"
4568
+ ],
4569
+ "additionalProperties": false
4570
+ },
4571
+ {
4572
+ "type": "string"
4573
+ },
4574
+ {
4575
+ "type": "boolean",
4576
+ "const": false
4558
4577
  }
4559
4578
  ]
4560
4579
  },
@@ -4562,7 +4581,7 @@
4562
4581
  "description": "Controls the background color of the icon.",
4563
4582
  "allOf": [
4564
4583
  {
4565
- "$ref": "#/definitions/PreviewEntry"
4584
+ "$ref": "#/definitions/PreviewEntries"
4566
4585
  }
4567
4586
  ],
4568
4587
  "markdownDescription": "Controls the background color of the icon."
@@ -7775,7 +7794,7 @@
7775
7794
  "description": "Controls the supporting text shown per item.",
7776
7795
  "allOf": [
7777
7796
  {
7778
- "$ref": "#/definitions/PreviewEntry"
7797
+ "$ref": "#/definitions/PreviewEntries"
7779
7798
  }
7780
7799
  ],
7781
7800
  "markdownDescription": "Controls the supporting text shown per item."
@@ -7808,6 +7827,14 @@
7808
7827
  }
7809
7828
  ]
7810
7829
  },
7830
+ "tags": {
7831
+ "description": "Defines a list of tags.",
7832
+ "type": "array",
7833
+ "items": {
7834
+ "type": "string"
7835
+ },
7836
+ "markdownDescription": "Defines a list of tags."
7837
+ },
7811
7838
  "metadata": {
7812
7839
  "description": "Defines a list of items that can contain an image, icon, and text.",
7813
7840
  "type": "array",
@@ -7833,7 +7860,7 @@
7833
7860
  "description": "Controls the main text shown per item.",
7834
7861
  "allOf": [
7835
7862
  {
7836
- "$ref": "#/definitions/PreviewEntry"
7863
+ "$ref": "#/definitions/PreviewEntries"
7837
7864
  }
7838
7865
  ],
7839
7866
  "markdownDescription": "Controls the main text shown per item."
@@ -7842,7 +7869,7 @@
7842
7869
  "description": "Controls the image shown per item.",
7843
7870
  "allOf": [
7844
7871
  {
7845
- "$ref": "#/definitions/PreviewEntry"
7872
+ "$ref": "#/definitions/PreviewEntries"
7846
7873
  }
7847
7874
  ],
7848
7875
  "markdownDescription": "Controls the image shown per item."
@@ -7851,7 +7878,7 @@
7851
7878
  "description": "Controls the icon shown per item. Must result in a Material Symbol name.",
7852
7879
  "allOf": [
7853
7880
  {
7854
- "$ref": "#/definitions/PreviewEntry"
7881
+ "$ref": "#/definitions/PreviewEntries"
7855
7882
  }
7856
7883
  ],
7857
7884
  "markdownDescription": "Controls the icon shown per item. Must result in a Material Symbol name."
@@ -7956,7 +7983,7 @@
7956
7983
  "description": "Controls the background color gallery area.",
7957
7984
  "allOf": [
7958
7985
  {
7959
- "$ref": "#/definitions/PreviewEntry"
7986
+ "$ref": "#/definitions/PreviewEntries"
7960
7987
  }
7961
7988
  ],
7962
7989
  "markdownDescription": "Controls the background color gallery area."
@@ -7981,7 +8008,7 @@
7981
8008
  "description": "Controls the supporting text shown per item.",
7982
8009
  "allOf": [
7983
8010
  {
7984
- "$ref": "#/definitions/PreviewEntry"
8011
+ "$ref": "#/definitions/PreviewEntries"
7985
8012
  }
7986
8013
  ],
7987
8014
  "markdownDescription": "Controls the supporting text shown per item."
@@ -8014,6 +8041,14 @@
8014
8041
  }
8015
8042
  ]
8016
8043
  },
8044
+ "tags": {
8045
+ "description": "Defines a list of tags.",
8046
+ "type": "array",
8047
+ "items": {
8048
+ "type": "string"
8049
+ },
8050
+ "markdownDescription": "Defines a list of tags."
8051
+ },
8017
8052
  "metadata": {
8018
8053
  "description": "Defines a list of items that can contain an image, icon, and text.",
8019
8054
  "type": "array",
@@ -9841,37 +9876,8 @@
9841
9876
  ],
9842
9877
  "markdownDescription": "This key defines the documentation link at the top of a _Collection browser_. Collection documentation is useful for assisting your team members."
9843
9878
  },
9844
- "sort": {
9845
- "description": "This key defines how CloudCannon sorts your Collection files when you first open your _Collection browser_.",
9846
- "title": "Sort",
9847
- "type": "object",
9848
- "properties": {
9849
- "key": {
9850
- "description": "Defines what field contains the value to sort on inside each collection item's data.",
9851
- "type": "string",
9852
- "markdownDescription": "Defines what field contains the value to sort on inside each collection item's data."
9853
- },
9854
- "order": {
9855
- "description": "Controls which sort values come first.",
9856
- "default": "ascending",
9857
- "type": "string",
9858
- "enum": [
9859
- "ascending",
9860
- "descending",
9861
- "asc",
9862
- "desc"
9863
- ],
9864
- "markdownDescription": "Controls which sort values come first."
9865
- }
9866
- },
9867
- "required": [
9868
- "key"
9869
- ],
9870
- "additionalProperties": false,
9871
- "markdownDescription": "This key defines how CloudCannon sorts your Collection files when you first open your _Collection browser_."
9872
- },
9873
9879
  "sort_options": {
9874
- "description": "This key defines the options for the Sort dropdown in a _Collection browser_.",
9880
+ "description": "This key defines the options for the Sort dropdown in a _Collection browser_. The first option listed is used as the default sort.",
9875
9881
  "type": "array",
9876
9882
  "items": {
9877
9883
  "title": "SortOption",
@@ -9907,7 +9913,21 @@
9907
9913
  "additionalProperties": false,
9908
9914
  "markdownDescription": "A sort option for a Collection."
9909
9915
  },
9910
- "markdownDescription": "This key defines the options for the Sort dropdown in a _Collection browser_."
9916
+ "markdownDescription": "This key defines the options for the Sort dropdown in a _Collection browser_. The first option listed is used as the default sort."
9917
+ },
9918
+ "view_options": {
9919
+ "uniqueItems": true,
9920
+ "description": "This key defines the options for the View dropdown in a _Collection browser_. The first option listed is used as the default view.",
9921
+ "type": "array",
9922
+ "items": {
9923
+ "type": "string",
9924
+ "enum": [
9925
+ "card",
9926
+ "list",
9927
+ "gallery"
9928
+ ]
9929
+ },
9930
+ "markdownDescription": "This key defines the options for the View dropdown in a _Collection browser_. The first option listed is used as the default view."
9911
9931
  },
9912
9932
  "singular_name": {
9913
9933
  "description": "This key defines the singular noun for your Collection name. CloudCannon uses the singular noun in the _+ Add_ button in the top right of the _Collection browser_.",