@financial-times/content-tree 0.13.0 → 0.14.0
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/SPEC.md +16 -15
- package/content-tree.d.ts +64 -40
- package/package.json +1 -1
- package/schemas/body-tree.schema.json +6 -24
- package/schemas/content-tree.schema.json +6 -24
- package/schemas/spark-transit-tree.schema.json +2165 -0
- package/schemas/transit-tree.schema.json +6 -26
package/SPEC.md
CHANGED
|
@@ -1016,20 +1016,24 @@ interface CarouselCard extends Node {
|
|
|
1016
1016
|
* @description unique identifier required for component tracking
|
|
1017
1017
|
*/
|
|
1018
1018
|
id: string
|
|
1019
|
-
/**
|
|
1020
|
-
* @description Heading (60 characters recommended)
|
|
1021
|
-
*/
|
|
1022
|
-
title: string
|
|
1023
1019
|
/**
|
|
1024
1020
|
* @description Image
|
|
1021
|
+
* @sparkMapNodeType image
|
|
1025
1022
|
*/
|
|
1026
1023
|
children: [ImageSet]
|
|
1024
|
+
/**
|
|
1025
|
+
* @description Heading (60 characters recommended)
|
|
1026
|
+
* @sparkMapNodeType textInput
|
|
1027
|
+
*/
|
|
1028
|
+
title: string
|
|
1027
1029
|
/**
|
|
1028
1030
|
* @description Body text (200 characters recommended)
|
|
1031
|
+
* @sparkMapNodeType textInput
|
|
1029
1032
|
*/
|
|
1030
1033
|
copy: string
|
|
1031
1034
|
/**
|
|
1032
1035
|
* @description Details (optional, 60 characters recommended)
|
|
1036
|
+
* @sparkMapNodeType textInput
|
|
1033
1037
|
*/
|
|
1034
1038
|
additionalInfo?: string
|
|
1035
1039
|
}
|
|
@@ -1048,16 +1052,6 @@ type CarouselChildren = CarouselCard[]
|
|
|
1048
1052
|
```
|
|
1049
1053
|
**CarouselChildren** the array of carousel cards that make up a carousel
|
|
1050
1054
|
|
|
1051
|
-
#### `CarouselHeading`
|
|
1052
|
-
```ts
|
|
1053
|
-
interface CarouselHeading extends Node {
|
|
1054
|
-
type: "carousel-heading"
|
|
1055
|
-
title: string
|
|
1056
|
-
standfirst?: string
|
|
1057
|
-
}
|
|
1058
|
-
```
|
|
1059
|
-
**CarouselHeading** is the main header for a carousel component
|
|
1060
|
-
|
|
1061
1055
|
#### `Carousel`
|
|
1062
1056
|
```ts
|
|
1063
1057
|
/**
|
|
@@ -1069,7 +1063,14 @@ interface Carousel extends Parent {
|
|
|
1069
1063
|
* @description unique identifier required for component tracking
|
|
1070
1064
|
*/
|
|
1071
1065
|
id: string
|
|
1072
|
-
|
|
1066
|
+
/**
|
|
1067
|
+
@sparkMapNodeType textInput
|
|
1068
|
+
*/
|
|
1069
|
+
title?: string
|
|
1070
|
+
/**
|
|
1071
|
+
@sparkMapNodeType textInput
|
|
1072
|
+
*/
|
|
1073
|
+
standfirst?: string
|
|
1073
1074
|
children: CarouselChildren
|
|
1074
1075
|
}
|
|
1075
1076
|
```
|
package/content-tree.d.ts
CHANGED
|
@@ -445,20 +445,24 @@ export declare namespace ContentTree {
|
|
|
445
445
|
* @description unique identifier required for component tracking
|
|
446
446
|
*/
|
|
447
447
|
id: string;
|
|
448
|
-
/**
|
|
449
|
-
* @description Heading (60 characters recommended)
|
|
450
|
-
*/
|
|
451
|
-
title: string;
|
|
452
448
|
/**
|
|
453
449
|
* @description Image
|
|
450
|
+
* @sparkMapNodeType image
|
|
454
451
|
*/
|
|
455
452
|
children: [ImageSet];
|
|
453
|
+
/**
|
|
454
|
+
* @description Heading (60 characters recommended)
|
|
455
|
+
* @sparkMapNodeType textInput
|
|
456
|
+
*/
|
|
457
|
+
title: string;
|
|
456
458
|
/**
|
|
457
459
|
* @description Body text (200 characters recommended)
|
|
460
|
+
* @sparkMapNodeType textInput
|
|
458
461
|
*/
|
|
459
462
|
copy: string;
|
|
460
463
|
/**
|
|
461
464
|
* @description Details (optional, 60 characters recommended)
|
|
465
|
+
* @sparkMapNodeType textInput
|
|
462
466
|
*/
|
|
463
467
|
additionalInfo?: string;
|
|
464
468
|
}
|
|
@@ -469,11 +473,6 @@ export declare namespace ContentTree {
|
|
|
469
473
|
* @sparkRepeater true
|
|
470
474
|
*/
|
|
471
475
|
type CarouselChildren = CarouselCard[];
|
|
472
|
-
interface CarouselHeading extends Node {
|
|
473
|
-
type: "carousel-heading";
|
|
474
|
-
title: string;
|
|
475
|
-
standfirst?: string;
|
|
476
|
-
}
|
|
477
476
|
/**
|
|
478
477
|
* @sparkGenerateStoryblock true
|
|
479
478
|
*/
|
|
@@ -483,7 +482,14 @@ export declare namespace ContentTree {
|
|
|
483
482
|
* @description unique identifier required for component tracking
|
|
484
483
|
*/
|
|
485
484
|
id: string;
|
|
486
|
-
|
|
485
|
+
/**
|
|
486
|
+
@sparkMapNodeType textInput
|
|
487
|
+
*/
|
|
488
|
+
title?: string;
|
|
489
|
+
/**
|
|
490
|
+
@sparkMapNodeType textInput
|
|
491
|
+
*/
|
|
492
|
+
standfirst?: string;
|
|
487
493
|
children: CarouselChildren;
|
|
488
494
|
}
|
|
489
495
|
namespace full {
|
|
@@ -933,20 +939,24 @@ export declare namespace ContentTree {
|
|
|
933
939
|
* @description unique identifier required for component tracking
|
|
934
940
|
*/
|
|
935
941
|
id: string;
|
|
936
|
-
/**
|
|
937
|
-
* @description Heading (60 characters recommended)
|
|
938
|
-
*/
|
|
939
|
-
title: string;
|
|
940
942
|
/**
|
|
941
943
|
* @description Image
|
|
944
|
+
* @sparkMapNodeType image
|
|
942
945
|
*/
|
|
943
946
|
children: [ImageSet];
|
|
947
|
+
/**
|
|
948
|
+
* @description Heading (60 characters recommended)
|
|
949
|
+
* @sparkMapNodeType textInput
|
|
950
|
+
*/
|
|
951
|
+
title: string;
|
|
944
952
|
/**
|
|
945
953
|
* @description Body text (200 characters recommended)
|
|
954
|
+
* @sparkMapNodeType textInput
|
|
946
955
|
*/
|
|
947
956
|
copy: string;
|
|
948
957
|
/**
|
|
949
958
|
* @description Details (optional, 60 characters recommended)
|
|
959
|
+
* @sparkMapNodeType textInput
|
|
950
960
|
*/
|
|
951
961
|
additionalInfo?: string;
|
|
952
962
|
}
|
|
@@ -957,11 +967,6 @@ export declare namespace ContentTree {
|
|
|
957
967
|
* @sparkRepeater true
|
|
958
968
|
*/
|
|
959
969
|
type CarouselChildren = CarouselCard[];
|
|
960
|
-
interface CarouselHeading extends Node {
|
|
961
|
-
type: "carousel-heading";
|
|
962
|
-
title: string;
|
|
963
|
-
standfirst?: string;
|
|
964
|
-
}
|
|
965
970
|
/**
|
|
966
971
|
* @sparkGenerateStoryblock true
|
|
967
972
|
*/
|
|
@@ -971,7 +976,14 @@ export declare namespace ContentTree {
|
|
|
971
976
|
* @description unique identifier required for component tracking
|
|
972
977
|
*/
|
|
973
978
|
id: string;
|
|
974
|
-
|
|
979
|
+
/**
|
|
980
|
+
@sparkMapNodeType textInput
|
|
981
|
+
*/
|
|
982
|
+
title?: string;
|
|
983
|
+
/**
|
|
984
|
+
@sparkMapNodeType textInput
|
|
985
|
+
*/
|
|
986
|
+
standfirst?: string;
|
|
975
987
|
children: CarouselChildren;
|
|
976
988
|
}
|
|
977
989
|
}
|
|
@@ -1395,20 +1407,24 @@ export declare namespace ContentTree {
|
|
|
1395
1407
|
* @description unique identifier required for component tracking
|
|
1396
1408
|
*/
|
|
1397
1409
|
id: string;
|
|
1398
|
-
/**
|
|
1399
|
-
* @description Heading (60 characters recommended)
|
|
1400
|
-
*/
|
|
1401
|
-
title: string;
|
|
1402
1410
|
/**
|
|
1403
1411
|
* @description Image
|
|
1412
|
+
* @sparkMapNodeType image
|
|
1404
1413
|
*/
|
|
1405
1414
|
children: [ImageSet];
|
|
1415
|
+
/**
|
|
1416
|
+
* @description Heading (60 characters recommended)
|
|
1417
|
+
* @sparkMapNodeType textInput
|
|
1418
|
+
*/
|
|
1419
|
+
title: string;
|
|
1406
1420
|
/**
|
|
1407
1421
|
* @description Body text (200 characters recommended)
|
|
1422
|
+
* @sparkMapNodeType textInput
|
|
1408
1423
|
*/
|
|
1409
1424
|
copy: string;
|
|
1410
1425
|
/**
|
|
1411
1426
|
* @description Details (optional, 60 characters recommended)
|
|
1427
|
+
* @sparkMapNodeType textInput
|
|
1412
1428
|
*/
|
|
1413
1429
|
additionalInfo?: string;
|
|
1414
1430
|
}
|
|
@@ -1419,11 +1435,6 @@ export declare namespace ContentTree {
|
|
|
1419
1435
|
* @sparkRepeater true
|
|
1420
1436
|
*/
|
|
1421
1437
|
type CarouselChildren = CarouselCard[];
|
|
1422
|
-
interface CarouselHeading extends Node {
|
|
1423
|
-
type: "carousel-heading";
|
|
1424
|
-
title: string;
|
|
1425
|
-
standfirst?: string;
|
|
1426
|
-
}
|
|
1427
1438
|
/**
|
|
1428
1439
|
* @sparkGenerateStoryblock true
|
|
1429
1440
|
*/
|
|
@@ -1433,7 +1444,14 @@ export declare namespace ContentTree {
|
|
|
1433
1444
|
* @description unique identifier required for component tracking
|
|
1434
1445
|
*/
|
|
1435
1446
|
id: string;
|
|
1436
|
-
|
|
1447
|
+
/**
|
|
1448
|
+
@sparkMapNodeType textInput
|
|
1449
|
+
*/
|
|
1450
|
+
title?: string;
|
|
1451
|
+
/**
|
|
1452
|
+
@sparkMapNodeType textInput
|
|
1453
|
+
*/
|
|
1454
|
+
standfirst?: string;
|
|
1437
1455
|
children: CarouselChildren;
|
|
1438
1456
|
}
|
|
1439
1457
|
}
|
|
@@ -1884,20 +1902,24 @@ export declare namespace ContentTree {
|
|
|
1884
1902
|
* @description unique identifier required for component tracking
|
|
1885
1903
|
*/
|
|
1886
1904
|
id: string;
|
|
1887
|
-
/**
|
|
1888
|
-
* @description Heading (60 characters recommended)
|
|
1889
|
-
*/
|
|
1890
|
-
title: string;
|
|
1891
1905
|
/**
|
|
1892
1906
|
* @description Image
|
|
1907
|
+
* @sparkMapNodeType image
|
|
1893
1908
|
*/
|
|
1894
1909
|
children: [ImageSet];
|
|
1910
|
+
/**
|
|
1911
|
+
* @description Heading (60 characters recommended)
|
|
1912
|
+
* @sparkMapNodeType textInput
|
|
1913
|
+
*/
|
|
1914
|
+
title: string;
|
|
1895
1915
|
/**
|
|
1896
1916
|
* @description Body text (200 characters recommended)
|
|
1917
|
+
* @sparkMapNodeType textInput
|
|
1897
1918
|
*/
|
|
1898
1919
|
copy: string;
|
|
1899
1920
|
/**
|
|
1900
1921
|
* @description Details (optional, 60 characters recommended)
|
|
1922
|
+
* @sparkMapNodeType textInput
|
|
1901
1923
|
*/
|
|
1902
1924
|
additionalInfo?: string;
|
|
1903
1925
|
}
|
|
@@ -1908,11 +1930,6 @@ export declare namespace ContentTree {
|
|
|
1908
1930
|
* @sparkRepeater true
|
|
1909
1931
|
*/
|
|
1910
1932
|
type CarouselChildren = CarouselCard[];
|
|
1911
|
-
interface CarouselHeading extends Node {
|
|
1912
|
-
type: "carousel-heading";
|
|
1913
|
-
title: string;
|
|
1914
|
-
standfirst?: string;
|
|
1915
|
-
}
|
|
1916
1933
|
/**
|
|
1917
1934
|
* @sparkGenerateStoryblock true
|
|
1918
1935
|
*/
|
|
@@ -1922,7 +1939,14 @@ export declare namespace ContentTree {
|
|
|
1922
1939
|
* @description unique identifier required for component tracking
|
|
1923
1940
|
*/
|
|
1924
1941
|
id: string;
|
|
1925
|
-
|
|
1942
|
+
/**
|
|
1943
|
+
@sparkMapNodeType textInput
|
|
1944
|
+
*/
|
|
1945
|
+
title?: string;
|
|
1946
|
+
/**
|
|
1947
|
+
@sparkMapNodeType textInput
|
|
1948
|
+
*/
|
|
1949
|
+
standfirst?: string;
|
|
1926
1950
|
children: CarouselChildren;
|
|
1927
1951
|
}
|
|
1928
1952
|
}
|
package/package.json
CHANGED
|
@@ -265,13 +265,16 @@
|
|
|
265
265
|
"type": "array"
|
|
266
266
|
},
|
|
267
267
|
"data": {},
|
|
268
|
-
"heading": {
|
|
269
|
-
"$ref": "#/definitions/ContentTree.transit.CarouselHeading"
|
|
270
|
-
},
|
|
271
268
|
"id": {
|
|
272
269
|
"description": "unique identifier required for component tracking",
|
|
273
270
|
"type": "string"
|
|
274
271
|
},
|
|
272
|
+
"standfirst": {
|
|
273
|
+
"type": "string"
|
|
274
|
+
},
|
|
275
|
+
"title": {
|
|
276
|
+
"type": "string"
|
|
277
|
+
},
|
|
275
278
|
"type": {
|
|
276
279
|
"const": "carousel",
|
|
277
280
|
"type": "string"
|
|
@@ -329,27 +332,6 @@
|
|
|
329
332
|
],
|
|
330
333
|
"type": "object"
|
|
331
334
|
},
|
|
332
|
-
"ContentTree.transit.CarouselHeading": {
|
|
333
|
-
"additionalProperties": false,
|
|
334
|
-
"properties": {
|
|
335
|
-
"data": {},
|
|
336
|
-
"standfirst": {
|
|
337
|
-
"type": "string"
|
|
338
|
-
},
|
|
339
|
-
"title": {
|
|
340
|
-
"type": "string"
|
|
341
|
-
},
|
|
342
|
-
"type": {
|
|
343
|
-
"const": "carousel-heading",
|
|
344
|
-
"type": "string"
|
|
345
|
-
}
|
|
346
|
-
},
|
|
347
|
-
"required": [
|
|
348
|
-
"title",
|
|
349
|
-
"type"
|
|
350
|
-
],
|
|
351
|
-
"type": "object"
|
|
352
|
-
},
|
|
353
335
|
"ContentTree.transit.ClipSet": {
|
|
354
336
|
"additionalProperties": false,
|
|
355
337
|
"properties": {
|
|
@@ -302,13 +302,16 @@
|
|
|
302
302
|
"type": "array"
|
|
303
303
|
},
|
|
304
304
|
"data": {},
|
|
305
|
-
"heading": {
|
|
306
|
-
"$ref": "#/definitions/ContentTree.full.CarouselHeading"
|
|
307
|
-
},
|
|
308
305
|
"id": {
|
|
309
306
|
"description": "unique identifier required for component tracking",
|
|
310
307
|
"type": "string"
|
|
311
308
|
},
|
|
309
|
+
"standfirst": {
|
|
310
|
+
"type": "string"
|
|
311
|
+
},
|
|
312
|
+
"title": {
|
|
313
|
+
"type": "string"
|
|
314
|
+
},
|
|
312
315
|
"type": {
|
|
313
316
|
"const": "carousel",
|
|
314
317
|
"type": "string"
|
|
@@ -366,27 +369,6 @@
|
|
|
366
369
|
],
|
|
367
370
|
"type": "object"
|
|
368
371
|
},
|
|
369
|
-
"ContentTree.full.CarouselHeading": {
|
|
370
|
-
"additionalProperties": false,
|
|
371
|
-
"properties": {
|
|
372
|
-
"data": {},
|
|
373
|
-
"standfirst": {
|
|
374
|
-
"type": "string"
|
|
375
|
-
},
|
|
376
|
-
"title": {
|
|
377
|
-
"type": "string"
|
|
378
|
-
},
|
|
379
|
-
"type": {
|
|
380
|
-
"const": "carousel-heading",
|
|
381
|
-
"type": "string"
|
|
382
|
-
}
|
|
383
|
-
},
|
|
384
|
-
"required": [
|
|
385
|
-
"title",
|
|
386
|
-
"type"
|
|
387
|
-
],
|
|
388
|
-
"type": "object"
|
|
389
|
-
},
|
|
390
372
|
"ContentTree.full.ClipSet": {
|
|
391
373
|
"additionalProperties": false,
|
|
392
374
|
"properties": {
|