@financial-times/content-tree 0.12.0-beta.3 → 0.12.0-beta.4

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.
Files changed (6) hide show
  1. package/SPEC.md +12 -3
  2. package/content-tree.d.ts +48 -12
  3. package/package.json +1 -1
  4. package/schemas/body-tree.schema.json +14 -7
  5. package/schemas/content-tree.schema.json +13 -7
  6. package/schemas/transit-tree.schema.json +13 -7
package/SPEC.md CHANGED
@@ -1012,9 +1012,17 @@ interface InfoPair extends Parent {
1012
1012
  ```ts
1013
1013
  interface CarouselCard extends Node {
1014
1014
  type: "carousel-card"
1015
- image: ImageSet
1015
+ /**
1016
+ * @description Heading (60 characters recommended)
1017
+ */
1016
1018
  title?: string
1017
- copy: Paragraph[]
1019
+ /**
1020
+ * @description Image and Body text (200 characters recommended)
1021
+ */
1022
+ children: [ImageSet, ...Paragraph[]]
1023
+ /**
1024
+ * @description Details (optional, 60 characters recommended)
1025
+ */
1018
1026
  additionalInfo?: string
1019
1027
  }
1020
1028
  ```
@@ -1023,6 +1031,7 @@ interface CarouselCard extends Node {
1023
1031
  #### `CarouselChildren`
1024
1032
  ```ts
1025
1033
  /**
1034
+ * @description Carousel item
1026
1035
  * @maxItems 10
1027
1036
  * @minItems 4
1028
1037
  * @sparkRepeater true
@@ -1044,7 +1053,7 @@ interface CarouselHeading extends Node {
1044
1053
  #### `Carousel`
1045
1054
  ```ts
1046
1055
  /**
1047
- * @sparkGenerateStoryBlock true
1056
+ * @sparkGenerateStoryblock true
1048
1057
  */
1049
1058
  interface Carousel extends Parent {
1050
1059
  type: "carousel"
package/content-tree.d.ts CHANGED
@@ -441,12 +441,21 @@ export declare namespace ContentTree {
441
441
  }
442
442
  interface CarouselCard extends Node {
443
443
  type: "carousel-card";
444
- image: ImageSet;
444
+ /**
445
+ * @description Heading (60 characters recommended)
446
+ */
445
447
  title?: string;
446
- copy: Paragraph[];
448
+ /**
449
+ * @description Image and Body text (200 characters recommended)
450
+ */
451
+ children: [ImageSet, ...Paragraph[]];
452
+ /**
453
+ * @description Details (optional, 60 characters recommended)
454
+ */
447
455
  additionalInfo?: string;
448
456
  }
449
457
  /**
458
+ * @description Carousel item
450
459
  * @maxItems 10
451
460
  * @minItems 4
452
461
  * @sparkRepeater true
@@ -458,7 +467,7 @@ export declare namespace ContentTree {
458
467
  standfirst?: string;
459
468
  }
460
469
  /**
461
- * @sparkGenerateStoryBlock true
470
+ * @sparkGenerateStoryblock true
462
471
  */
463
472
  interface Carousel extends Parent {
464
473
  type: "carousel";
@@ -908,12 +917,21 @@ export declare namespace ContentTree {
908
917
  }
909
918
  interface CarouselCard extends Node {
910
919
  type: "carousel-card";
911
- image: ImageSet;
920
+ /**
921
+ * @description Heading (60 characters recommended)
922
+ */
912
923
  title?: string;
913
- copy: Paragraph[];
924
+ /**
925
+ * @description Image and Body text (200 characters recommended)
926
+ */
927
+ children: [ImageSet, ...Paragraph[]];
928
+ /**
929
+ * @description Details (optional, 60 characters recommended)
930
+ */
914
931
  additionalInfo?: string;
915
932
  }
916
933
  /**
934
+ * @description Carousel item
917
935
  * @maxItems 10
918
936
  * @minItems 4
919
937
  * @sparkRepeater true
@@ -925,7 +943,7 @@ export declare namespace ContentTree {
925
943
  standfirst?: string;
926
944
  }
927
945
  /**
928
- * @sparkGenerateStoryBlock true
946
+ * @sparkGenerateStoryblock true
929
947
  */
930
948
  interface Carousel extends Parent {
931
949
  type: "carousel";
@@ -1349,12 +1367,21 @@ export declare namespace ContentTree {
1349
1367
  }
1350
1368
  interface CarouselCard extends Node {
1351
1369
  type: "carousel-card";
1352
- image: ImageSet;
1370
+ /**
1371
+ * @description Heading (60 characters recommended)
1372
+ */
1353
1373
  title?: string;
1354
- copy: Paragraph[];
1374
+ /**
1375
+ * @description Image and Body text (200 characters recommended)
1376
+ */
1377
+ children: [ImageSet, ...Paragraph[]];
1378
+ /**
1379
+ * @description Details (optional, 60 characters recommended)
1380
+ */
1355
1381
  additionalInfo?: string;
1356
1382
  }
1357
1383
  /**
1384
+ * @description Carousel item
1358
1385
  * @maxItems 10
1359
1386
  * @minItems 4
1360
1387
  * @sparkRepeater true
@@ -1366,7 +1393,7 @@ export declare namespace ContentTree {
1366
1393
  standfirst?: string;
1367
1394
  }
1368
1395
  /**
1369
- * @sparkGenerateStoryBlock true
1396
+ * @sparkGenerateStoryblock true
1370
1397
  */
1371
1398
  interface Carousel extends Parent {
1372
1399
  type: "carousel";
@@ -1817,12 +1844,21 @@ export declare namespace ContentTree {
1817
1844
  }
1818
1845
  interface CarouselCard extends Node {
1819
1846
  type: "carousel-card";
1820
- image: ImageSet;
1847
+ /**
1848
+ * @description Heading (60 characters recommended)
1849
+ */
1821
1850
  title?: string;
1822
- copy: Paragraph[];
1851
+ /**
1852
+ * @description Image and Body text (200 characters recommended)
1853
+ */
1854
+ children: [ImageSet, ...Paragraph[]];
1855
+ /**
1856
+ * @description Details (optional, 60 characters recommended)
1857
+ */
1823
1858
  additionalInfo?: string;
1824
1859
  }
1825
1860
  /**
1861
+ * @description Carousel item
1826
1862
  * @maxItems 10
1827
1863
  * @minItems 4
1828
1864
  * @sparkRepeater true
@@ -1834,7 +1870,7 @@ export declare namespace ContentTree {
1834
1870
  standfirst?: string;
1835
1871
  }
1836
1872
  /**
1837
- * @sparkGenerateStoryBlock true
1873
+ * @sparkGenerateStoryblock true
1838
1874
  */
1839
1875
  interface Carousel extends Parent {
1840
1876
  type: "carousel";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@financial-times/content-tree",
3
3
  "description": "content tree format",
4
- "version": "0.12.0-beta.3",
4
+ "version": "0.12.0-beta.4",
5
5
  "publishConfig": {
6
6
  "access": "public"
7
7
  },
package/schemas/body-tree.schema.json CHANGED
@@ -253,6 +253,7 @@
253
253
  "additionalProperties": false,
254
254
  "properties": {
255
255
  "children": {
256
+ "description": "Carousel item",
256
257
  "items": {
257
258
  "$ref": "#/definitions/ContentTree.transit.CarouselCard"
258
259
  },
@@ -274,25 +275,32 @@
274
275
  "children",
275
276
  "type"
276
277
  ],
278
+ "sparkGenerateStoryblock": true,
277
279
  "type": "object"
278
280
  },
279
281
  "ContentTree.transit.CarouselCard": {
280
282
  "additionalProperties": false,
281
283
  "properties": {
282
284
  "additionalInfo": {
285
+ "description": "Details (optional, 60 characters recommended)",
283
286
  "type": "string"
284
287
  },
285
- "copy": {
286
- "items": {
288
+ "children": {
289
+ "additionalItems": {
287
290
  "$ref": "#/definitions/ContentTree.transit.Paragraph"
288
291
  },
292
+ "description": "Image and Body text (200 characters recommended)",
293
+ "items": [
294
+ {
295
+ "$ref": "#/definitions/ContentTree.transit.ImageSet"
296
+ }
297
+ ],
298
+ "minItems": 1,
289
299
  "type": "array"
290
300
  },
291
301
  "data": {},
292
- "image": {
293
- "$ref": "#/definitions/ContentTree.transit.ImageSet"
294
- },
295
302
  "title": {
303
+ "description": "Heading (60 characters recommended)",
296
304
  "type": "string"
297
305
  },
298
306
  "type": {
@@ -301,8 +309,7 @@
301
309
  }
302
310
  },
303
311
  "required": [
304
- "copy",
305
- "image",
312
+ "children",
306
313
  "type"
307
314
  ],
308
315
  "type": "object"
package/schemas/content-tree.schema.json CHANGED
@@ -290,6 +290,7 @@
290
290
  "additionalProperties": false,
291
291
  "properties": {
292
292
  "children": {
293
+ "description": "Carousel item",
293
294
  "items": {
294
295
  "$ref": "#/definitions/ContentTree.full.CarouselCard"
295
296
  },
@@ -316,19 +317,25 @@
316
317
  "additionalProperties": false,
317
318
  "properties": {
318
319
  "additionalInfo": {
320
+ "description": "Details (optional, 60 characters recommended)",
319
321
  "type": "string"
320
322
  },
321
- "copy": {
322
- "items": {
323
+ "children": {
324
+ "additionalItems": {
323
325
  "$ref": "#/definitions/ContentTree.full.Paragraph"
324
326
  },
327
+ "description": "Image and Body text (200 characters recommended)",
328
+ "items": [
329
+ {
330
+ "$ref": "#/definitions/ContentTree.full.ImageSet"
331
+ }
332
+ ],
333
+ "minItems": 1,
325
334
  "type": "array"
326
335
  },
327
336
  "data": {},
328
- "image": {
329
- "$ref": "#/definitions/ContentTree.full.ImageSet"
330
- },
331
337
  "title": {
338
+ "description": "Heading (60 characters recommended)",
332
339
  "type": "string"
333
340
  },
334
341
  "type": {
@@ -337,8 +344,7 @@
337
344
  }
338
345
  },
339
346
  "required": [
340
- "copy",
341
- "image",
347
+ "children",
342
348
  "type"
343
349
  ],
344
350
  "type": "object"
package/schemas/transit-tree.schema.json CHANGED
@@ -278,6 +278,7 @@
278
278
  "additionalProperties": false,
279
279
  "properties": {
280
280
  "children": {
281
+ "description": "Carousel item",
281
282
  "items": {
282
283
  "$ref": "#/definitions/ContentTree.transit.CarouselCard"
283
284
  },
@@ -304,19 +305,25 @@
304
305
  "additionalProperties": false,
305
306
  "properties": {
306
307
  "additionalInfo": {
308
+ "description": "Details (optional, 60 characters recommended)",
307
309
  "type": "string"
308
310
  },
309
- "copy": {
310
- "items": {
311
+ "children": {
312
+ "additionalItems": {
311
313
  "$ref": "#/definitions/ContentTree.transit.Paragraph"
312
314
  },
315
+ "description": "Image and Body text (200 characters recommended)",
316
+ "items": [
317
+ {
318
+ "$ref": "#/definitions/ContentTree.transit.ImageSet"
319
+ }
320
+ ],
321
+ "minItems": 1,
313
322
  "type": "array"
314
323
  },
315
324
  "data": {},
316
- "image": {
317
- "$ref": "#/definitions/ContentTree.transit.ImageSet"
318
- },
319
325
  "title": {
326
+ "description": "Heading (60 characters recommended)",
320
327
  "type": "string"
321
328
  },
322
329
  "type": {
@@ -325,8 +332,7 @@
325
332
  }
326
333
  },
327
334
  "required": [
328
- "copy",
329
- "image",
335
+ "children",
330
336
  "type"
331
337
  ],
332
338
  "type": "object"