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

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 +9 -3
  2. package/content-tree.d.ts +36 -12
  3. package/package.json +1 -1
  4. package/schemas/body-tree.schema.json +16 -4
  5. package/schemas/content-tree.schema.json +16 -4
  6. package/schemas/transit-tree.schema.json +16 -4
package/SPEC.md CHANGED
@@ -1012,14 +1012,19 @@ interface InfoPair extends Parent {
1012
1012
  ```ts
1013
1013
  interface CarouselCard extends Node {
1014
1014
  type: "carousel-card"
1015
+ id: string
1015
1016
  /**
1016
1017
  * @description Heading (60 characters recommended)
1017
1018
  */
1018
- title?: string
1019
+ title: string
1019
1020
  /**
1020
- * @description Image and Body text (200 characters recommended)
1021
+ * @description Image
1021
1022
  */
1022
- children: [ImageSet, ...Paragraph[]]
1023
+ children: [ImageSet]
1024
+ /**
1025
+ * @description Body text (200 characters recommended)
1026
+ */
1027
+ copy: string
1023
1028
  /**
1024
1029
  * @description Details (optional, 60 characters recommended)
1025
1030
  */
@@ -1057,6 +1062,7 @@ interface CarouselHeading extends Node {
1057
1062
  */
1058
1063
  interface Carousel extends Parent {
1059
1064
  type: "carousel"
1065
+ id: string
1060
1066
  heading?: CarouselHeading
1061
1067
  children: CarouselChildren
1062
1068
  }
package/content-tree.d.ts CHANGED
@@ -441,14 +441,19 @@ export declare namespace ContentTree {
441
441
  }
442
442
  interface CarouselCard extends Node {
443
443
  type: "carousel-card";
444
+ id: string;
444
445
  /**
445
446
  * @description Heading (60 characters recommended)
446
447
  */
447
- title?: string;
448
+ title: string;
448
449
  /**
449
- * @description Image and Body text (200 characters recommended)
450
+ * @description Image
450
451
  */
451
- children: [ImageSet, ...Paragraph[]];
452
+ children: [ImageSet];
453
+ /**
454
+ * @description Body text (200 characters recommended)
455
+ */
456
+ copy: string;
452
457
  /**
453
458
  * @description Details (optional, 60 characters recommended)
454
459
  */
@@ -471,6 +476,7 @@ export declare namespace ContentTree {
471
476
  */
472
477
  interface Carousel extends Parent {
473
478
  type: "carousel";
479
+ id: string;
474
480
  heading?: CarouselHeading;
475
481
  children: CarouselChildren;
476
482
  }
@@ -917,14 +923,19 @@ export declare namespace ContentTree {
917
923
  }
918
924
  interface CarouselCard extends Node {
919
925
  type: "carousel-card";
926
+ id: string;
920
927
  /**
921
928
  * @description Heading (60 characters recommended)
922
929
  */
923
- title?: string;
930
+ title: string;
924
931
  /**
925
- * @description Image and Body text (200 characters recommended)
932
+ * @description Image
926
933
  */
927
- children: [ImageSet, ...Paragraph[]];
934
+ children: [ImageSet];
935
+ /**
936
+ * @description Body text (200 characters recommended)
937
+ */
938
+ copy: string;
928
939
  /**
929
940
  * @description Details (optional, 60 characters recommended)
930
941
  */
@@ -947,6 +958,7 @@ export declare namespace ContentTree {
947
958
  */
948
959
  interface Carousel extends Parent {
949
960
  type: "carousel";
961
+ id: string;
950
962
  heading?: CarouselHeading;
951
963
  children: CarouselChildren;
952
964
  }
@@ -1367,14 +1379,19 @@ export declare namespace ContentTree {
1367
1379
  }
1368
1380
  interface CarouselCard extends Node {
1369
1381
  type: "carousel-card";
1382
+ id: string;
1370
1383
  /**
1371
1384
  * @description Heading (60 characters recommended)
1372
1385
  */
1373
- title?: string;
1386
+ title: string;
1374
1387
  /**
1375
- * @description Image and Body text (200 characters recommended)
1388
+ * @description Image
1376
1389
  */
1377
- children: [ImageSet, ...Paragraph[]];
1390
+ children: [ImageSet];
1391
+ /**
1392
+ * @description Body text (200 characters recommended)
1393
+ */
1394
+ copy: string;
1378
1395
  /**
1379
1396
  * @description Details (optional, 60 characters recommended)
1380
1397
  */
@@ -1397,6 +1414,7 @@ export declare namespace ContentTree {
1397
1414
  */
1398
1415
  interface Carousel extends Parent {
1399
1416
  type: "carousel";
1417
+ id: string;
1400
1418
  heading?: CarouselHeading;
1401
1419
  children: CarouselChildren;
1402
1420
  }
@@ -1844,14 +1862,19 @@ export declare namespace ContentTree {
1844
1862
  }
1845
1863
  interface CarouselCard extends Node {
1846
1864
  type: "carousel-card";
1865
+ id: string;
1847
1866
  /**
1848
1867
  * @description Heading (60 characters recommended)
1849
1868
  */
1850
- title?: string;
1869
+ title: string;
1851
1870
  /**
1852
- * @description Image and Body text (200 characters recommended)
1871
+ * @description Image
1853
1872
  */
1854
- children: [ImageSet, ...Paragraph[]];
1873
+ children: [ImageSet];
1874
+ /**
1875
+ * @description Body text (200 characters recommended)
1876
+ */
1877
+ copy: string;
1855
1878
  /**
1856
1879
  * @description Details (optional, 60 characters recommended)
1857
1880
  */
@@ -1874,6 +1897,7 @@ export declare namespace ContentTree {
1874
1897
  */
1875
1898
  interface Carousel extends Parent {
1876
1899
  type: "carousel";
1900
+ id: string;
1877
1901
  heading?: CarouselHeading;
1878
1902
  children: CarouselChildren;
1879
1903
  }
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.4",
4
+ "version": "0.12.0-beta.8",
5
5
  "publishConfig": {
6
6
  "access": "public"
7
7
  },
package/schemas/body-tree.schema.json CHANGED
@@ -266,6 +266,9 @@
266
266
  "heading": {
267
267
  "$ref": "#/definitions/ContentTree.transit.CarouselHeading"
268
268
  },
269
+ "id": {
270
+ "type": "string"
271
+ },
269
272
  "type": {
270
273
  "const": "carousel",
271
274
  "type": "string"
@@ -273,6 +276,7 @@
273
276
  },
274
277
  "required": [
275
278
  "children",
279
+ "id",
276
280
  "type"
277
281
  ],
278
282
  "sparkGenerateStoryblock": true,
@@ -286,19 +290,24 @@
286
290
  "type": "string"
287
291
  },
288
292
  "children": {
289
- "additionalItems": {
290
- "$ref": "#/definitions/ContentTree.transit.Paragraph"
291
- },
292
- "description": "Image and Body text (200 characters recommended)",
293
+ "description": "Image",
293
294
  "items": [
294
295
  {
295
296
  "$ref": "#/definitions/ContentTree.transit.ImageSet"
296
297
  }
297
298
  ],
299
+ "maxItems": 1,
298
300
  "minItems": 1,
299
301
  "type": "array"
300
302
  },
303
+ "copy": {
304
+ "description": "Body text (200 characters recommended)",
305
+ "type": "string"
306
+ },
301
307
  "data": {},
308
+ "id": {
309
+ "type": "string"
310
+ },
302
311
  "title": {
303
312
  "description": "Heading (60 characters recommended)",
304
313
  "type": "string"
@@ -310,6 +319,9 @@
310
319
  },
311
320
  "required": [
312
321
  "children",
322
+ "copy",
323
+ "id",
324
+ "title",
313
325
  "type"
314
326
  ],
315
327
  "type": "object"
package/schemas/content-tree.schema.json CHANGED
@@ -302,6 +302,9 @@
302
302
  "heading": {
303
303
  "$ref": "#/definitions/ContentTree.full.CarouselHeading"
304
304
  },
305
+ "id": {
306
+ "type": "string"
307
+ },
305
308
  "type": {
306
309
  "const": "carousel",
307
310
  "type": "string"
@@ -309,6 +312,7 @@
309
312
  },
310
313
  "required": [
311
314
  "children",
315
+ "id",
312
316
  "type"
313
317
  ],
314
318
  "type": "object"
@@ -321,19 +325,24 @@
321
325
  "type": "string"
322
326
  },
323
327
  "children": {
324
- "additionalItems": {
325
- "$ref": "#/definitions/ContentTree.full.Paragraph"
326
- },
327
- "description": "Image and Body text (200 characters recommended)",
328
+ "description": "Image",
328
329
  "items": [
329
330
  {
330
331
  "$ref": "#/definitions/ContentTree.full.ImageSet"
331
332
  }
332
333
  ],
334
+ "maxItems": 1,
333
335
  "minItems": 1,
334
336
  "type": "array"
335
337
  },
338
+ "copy": {
339
+ "description": "Body text (200 characters recommended)",
340
+ "type": "string"
341
+ },
336
342
  "data": {},
343
+ "id": {
344
+ "type": "string"
345
+ },
337
346
  "title": {
338
347
  "description": "Heading (60 characters recommended)",
339
348
  "type": "string"
@@ -345,6 +354,9 @@
345
354
  },
346
355
  "required": [
347
356
  "children",
357
+ "copy",
358
+ "id",
359
+ "title",
348
360
  "type"
349
361
  ],
350
362
  "type": "object"
package/schemas/transit-tree.schema.json CHANGED
@@ -290,6 +290,9 @@
290
290
  "heading": {
291
291
  "$ref": "#/definitions/ContentTree.transit.CarouselHeading"
292
292
  },
293
+ "id": {
294
+ "type": "string"
295
+ },
293
296
  "type": {
294
297
  "const": "carousel",
295
298
  "type": "string"
@@ -297,6 +300,7 @@
297
300
  },
298
301
  "required": [
299
302
  "children",
303
+ "id",
300
304
  "type"
301
305
  ],
302
306
  "type": "object"
@@ -309,19 +313,24 @@
309
313
  "type": "string"
310
314
  },
311
315
  "children": {
312
- "additionalItems": {
313
- "$ref": "#/definitions/ContentTree.transit.Paragraph"
314
- },
315
- "description": "Image and Body text (200 characters recommended)",
316
+ "description": "Image",
316
317
  "items": [
317
318
  {
318
319
  "$ref": "#/definitions/ContentTree.transit.ImageSet"
319
320
  }
320
321
  ],
322
+ "maxItems": 1,
321
323
  "minItems": 1,
322
324
  "type": "array"
323
325
  },
326
+ "copy": {
327
+ "description": "Body text (200 characters recommended)",
328
+ "type": "string"
329
+ },
324
330
  "data": {},
331
+ "id": {
332
+ "type": "string"
333
+ },
325
334
  "title": {
326
335
  "description": "Heading (60 characters recommended)",
327
336
  "type": "string"
@@ -333,6 +342,9 @@
333
342
  },
334
343
  "required": [
335
344
  "children",
345
+ "copy",
346
+ "id",
347
+ "title",
336
348
  "type"
337
349
  ],
338
350
  "type": "object"