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

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 +10 -4
  2. package/content-tree.d.ts +36 -12
  3. package/package.json +1 -1
  4. package/schemas/body-tree.schema.json +18 -4
  5. package/schemas/content-tree.schema.json +18 -4
  6. package/schemas/transit-tree.schema.json +18 -4
package/SPEC.md CHANGED
@@ -1011,15 +1011,20 @@ interface InfoPair extends Parent {
1011
1011
  #### `CarouselCard`
1012
1012
  ```ts
1013
1013
  interface CarouselCard extends Node {
1014
- type: "carousel-card"
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;
449
+ /**
450
+ * @description Image
451
+ */
452
+ children: [ImageSet];
448
453
  /**
449
- * @description Image and Body text (200 characters recommended)
454
+ * @description Body text (200 characters recommended)
450
455
  */
451
- children: [ImageSet, ...Paragraph[]];
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;
931
+ /**
932
+ * @description Image
933
+ */
934
+ children: [ImageSet];
924
935
  /**
925
- * @description Image and Body text (200 characters recommended)
936
+ * @description Body text (200 characters recommended)
926
937
  */
927
- children: [ImageSet, ...Paragraph[]];
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;
1387
+ /**
1388
+ * @description Image
1389
+ */
1390
+ children: [ImageSet];
1374
1391
  /**
1375
- * @description Image and Body text (200 characters recommended)
1392
+ * @description Body text (200 characters recommended)
1376
1393
  */
1377
- children: [ImageSet, ...Paragraph[]];
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;
1870
+ /**
1871
+ * @description Image
1872
+ */
1873
+ children: [ImageSet];
1851
1874
  /**
1852
- * @description Image and Body text (200 characters recommended)
1875
+ * @description Body text (200 characters recommended)
1853
1876
  */
1854
- children: [ImageSet, ...Paragraph[]];
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.7",
5
5
  "publishConfig": {
6
6
  "access": "public"
7
7
  },
package/schemas/body-tree.schema.json CHANGED
@@ -266,6 +266,10 @@
266
266
  "heading": {
267
267
  "$ref": "#/definitions/ContentTree.transit.CarouselHeading"
268
268
  },
269
+ "id": {
270
+ "const": "string",
271
+ "type": "string"
272
+ },
269
273
  "type": {
270
274
  "const": "carousel",
271
275
  "type": "string"
@@ -273,6 +277,7 @@
273
277
  },
274
278
  "required": [
275
279
  "children",
280
+ "id",
276
281
  "type"
277
282
  ],
278
283
  "sparkGenerateStoryblock": true,
@@ -286,19 +291,25 @@
286
291
  "type": "string"
287
292
  },
288
293
  "children": {
289
- "additionalItems": {
290
- "$ref": "#/definitions/ContentTree.transit.Paragraph"
291
- },
292
- "description": "Image and Body text (200 characters recommended)",
294
+ "description": "Image",
293
295
  "items": [
294
296
  {
295
297
  "$ref": "#/definitions/ContentTree.transit.ImageSet"
296
298
  }
297
299
  ],
300
+ "maxItems": 1,
298
301
  "minItems": 1,
299
302
  "type": "array"
300
303
  },
304
+ "copy": {
305
+ "description": "Body text (200 characters recommended)",
306
+ "type": "string"
307
+ },
301
308
  "data": {},
309
+ "id": {
310
+ "const": "string",
311
+ "type": "string"
312
+ },
302
313
  "title": {
303
314
  "description": "Heading (60 characters recommended)",
304
315
  "type": "string"
@@ -310,6 +321,9 @@
310
321
  },
311
322
  "required": [
312
323
  "children",
324
+ "copy",
325
+ "id",
326
+ "title",
313
327
  "type"
314
328
  ],
315
329
  "type": "object"
package/schemas/content-tree.schema.json CHANGED
@@ -302,6 +302,10 @@
302
302
  "heading": {
303
303
  "$ref": "#/definitions/ContentTree.full.CarouselHeading"
304
304
  },
305
+ "id": {
306
+ "const": "string",
307
+ "type": "string"
308
+ },
305
309
  "type": {
306
310
  "const": "carousel",
307
311
  "type": "string"
@@ -309,6 +313,7 @@
309
313
  },
310
314
  "required": [
311
315
  "children",
316
+ "id",
312
317
  "type"
313
318
  ],
314
319
  "type": "object"
@@ -321,19 +326,25 @@
321
326
  "type": "string"
322
327
  },
323
328
  "children": {
324
- "additionalItems": {
325
- "$ref": "#/definitions/ContentTree.full.Paragraph"
326
- },
327
- "description": "Image and Body text (200 characters recommended)",
329
+ "description": "Image",
328
330
  "items": [
329
331
  {
330
332
  "$ref": "#/definitions/ContentTree.full.ImageSet"
331
333
  }
332
334
  ],
335
+ "maxItems": 1,
333
336
  "minItems": 1,
334
337
  "type": "array"
335
338
  },
339
+ "copy": {
340
+ "description": "Body text (200 characters recommended)",
341
+ "type": "string"
342
+ },
336
343
  "data": {},
344
+ "id": {
345
+ "const": "string",
346
+ "type": "string"
347
+ },
337
348
  "title": {
338
349
  "description": "Heading (60 characters recommended)",
339
350
  "type": "string"
@@ -345,6 +356,9 @@
345
356
  },
346
357
  "required": [
347
358
  "children",
359
+ "copy",
360
+ "id",
361
+ "title",
348
362
  "type"
349
363
  ],
350
364
  "type": "object"
package/schemas/transit-tree.schema.json CHANGED
@@ -290,6 +290,10 @@
290
290
  "heading": {
291
291
  "$ref": "#/definitions/ContentTree.transit.CarouselHeading"
292
292
  },
293
+ "id": {
294
+ "const": "string",
295
+ "type": "string"
296
+ },
293
297
  "type": {
294
298
  "const": "carousel",
295
299
  "type": "string"
@@ -297,6 +301,7 @@
297
301
  },
298
302
  "required": [
299
303
  "children",
304
+ "id",
300
305
  "type"
301
306
  ],
302
307
  "type": "object"
@@ -309,19 +314,25 @@
309
314
  "type": "string"
310
315
  },
311
316
  "children": {
312
- "additionalItems": {
313
- "$ref": "#/definitions/ContentTree.transit.Paragraph"
314
- },
315
- "description": "Image and Body text (200 characters recommended)",
317
+ "description": "Image",
316
318
  "items": [
317
319
  {
318
320
  "$ref": "#/definitions/ContentTree.transit.ImageSet"
319
321
  }
320
322
  ],
323
+ "maxItems": 1,
321
324
  "minItems": 1,
322
325
  "type": "array"
323
326
  },
327
+ "copy": {
328
+ "description": "Body text (200 characters recommended)",
329
+ "type": "string"
330
+ },
324
331
  "data": {},
332
+ "id": {
333
+ "const": "string",
334
+ "type": "string"
335
+ },
325
336
  "title": {
326
337
  "description": "Heading (60 characters recommended)",
327
338
  "type": "string"
@@ -333,6 +344,9 @@
333
344
  },
334
345
  "required": [
335
346
  "children",
347
+ "copy",
348
+ "id",
349
+ "title",
336
350
  "type"
337
351
  ],
338
352
  "type": "object"