@financial-times/content-tree 0.10.0 → 0.12.0-beta.2

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 (7) hide show
  1. package/README.md +15 -0
  2. package/SPEC.md +76 -24
  3. package/content-tree.d.ts +136 -12
  4. package/package.json +1 -1
  5. package/schemas/body-tree.schema.json +193 -76
  6. package/schemas/content-tree.schema.json +192 -76
  7. package/schemas/transit-tree.schema.json +192 -76
package/schemas/body-tree.schema.json CHANGED
@@ -116,70 +116,73 @@
116
116
  "$ref": "#/definitions/ContentTree.transit.Text"
117
117
  },
118
118
  {
119
- "$ref": "#/definitions/ContentTree.transit.ImageSet"
119
+ "$ref": "#/definitions/ContentTree.transit.AcastPodcast"
120
120
  },
121
121
  {
122
- "$ref": "#/definitions/ContentTree.transit.Flourish"
122
+ "$ref": "#/definitions/ContentTree.transit.BigNumber"
123
123
  },
124
124
  {
125
- "$ref": "#/definitions/ContentTree.transit.BigNumber"
125
+ "$ref": "#/definitions/ContentTree.transit.Carousel"
126
+ },
127
+ {
128
+ "$ref": "#/definitions/ContentTree.transit.ClipSet"
126
129
  },
127
130
  {
128
131
  "$ref": "#/definitions/ContentTree.transit.CustomCodeComponent"
129
132
  },
130
133
  {
131
- "$ref": "#/definitions/ContentTree.transit.Layout"
134
+ "$ref": "#/definitions/ContentTree.transit.Definition"
132
135
  },
133
136
  {
134
- "$ref": "#/definitions/ContentTree.transit.Pullquote"
137
+ "$ref": "#/definitions/ContentTree.transit.Flourish"
135
138
  },
136
139
  {
137
- "$ref": "#/definitions/ContentTree.transit.ScrollyBlock"
140
+ "$ref": "#/definitions/ContentTree.transit.ImagePair"
138
141
  },
139
142
  {
140
- "$ref": "#/definitions/ContentTree.transit.ClipSet"
143
+ "$ref": "#/definitions/ContentTree.transit.ImageSet"
141
144
  },
142
145
  {
143
- "$ref": "#/definitions/ContentTree.transit.Table"
146
+ "$ref": "#/definitions/ContentTree.transit.InfoBox"
144
147
  },
145
148
  {
146
- "$ref": "#/definitions/ContentTree.transit.Recommended"
149
+ "$ref": "#/definitions/ContentTree.transit.InfoPair"
147
150
  },
148
151
  {
149
- "$ref": "#/definitions/ContentTree.transit.RecommendedList"
152
+ "$ref": "#/definitions/ContentTree.transit.InNumbers"
150
153
  },
151
154
  {
152
- "$ref": "#/definitions/ContentTree.transit.Tweet"
155
+ "$ref": "#/definitions/ContentTree.transit.Layout"
153
156
  },
154
157
  {
155
- "$ref": "#/definitions/ContentTree.transit.Video"
158
+ "$ref": "#/definitions/ContentTree.transit.Pullquote"
156
159
  },
157
160
  {
158
- "$ref": "#/definitions/ContentTree.transit.YoutubeVideo"
161
+ "$ref": "#/definitions/ContentTree.transit.Recommended"
159
162
  },
160
163
  {
161
- "$ref": "#/definitions/ContentTree.transit.VimeoVideo"
164
+ "$ref": "#/definitions/ContentTree.transit.RecommendedList"
162
165
  },
163
166
  {
164
- "$ref": "#/definitions/ContentTree.transit.AcastPodcast"
167
+ "$ref": "#/definitions/ContentTree.transit.ScrollyBlock"
165
168
  },
166
169
  {
167
- "$ref": "#/definitions/ContentTree.transit.Timeline"
170
+ "$ref": "#/definitions/ContentTree.transit.Table"
168
171
  },
169
172
  {
170
- "$ref": "#/definitions/ContentTree.transit.ImagePair"
173
+ "$ref": "#/definitions/ContentTree.transit.Timeline"
171
174
  },
172
175
  {
173
- "$ref": "#/definitions/ContentTree.transit.InNumbers"
176
+ "$ref": "#/definitions/ContentTree.transit.Tweet"
174
177
  },
175
178
  {
176
- "$ref": "#/definitions/ContentTree.transit.Definition"
179
+ "$ref": "#/definitions/ContentTree.transit.Video"
177
180
  },
178
181
  {
179
- "$ref": "#/definitions/ContentTree.transit.InfoBox"
182
+ "$ref": "#/definitions/ContentTree.transit.VimeoVideo"
180
183
  },
181
184
  {
182
- "$ref": "#/definitions/ContentTree.transit.InfoPair"
185
+ "$ref": "#/definitions/ContentTree.transit.YoutubeVideo"
183
186
  }
184
187
  ]
185
188
  },
@@ -246,6 +249,85 @@
246
249
  ],
247
250
  "description": "Allowed children for a card"
248
251
  },
252
+ "ContentTree.transit.Carousel": {
253
+ "additionalProperties": false,
254
+ "properties": {
255
+ "children": {
256
+ "items": {
257
+ "$ref": "#/definitions/ContentTree.transit.CarouselCard"
258
+ },
259
+ "maxItems": 10,
260
+ "minItems": 4,
261
+ "sparkRepeater": true,
262
+ "type": "array"
263
+ },
264
+ "data": {},
265
+ "heading": {
266
+ "$ref": "#/definitions/ContentTree.transit.CarouselHeading"
267
+ },
268
+ "type": {
269
+ "const": "carousel",
270
+ "type": "string"
271
+ }
272
+ },
273
+ "required": [
274
+ "children",
275
+ "type"
276
+ ],
277
+ "type": "object"
278
+ },
279
+ "ContentTree.transit.CarouselCard": {
280
+ "additionalProperties": false,
281
+ "properties": {
282
+ "additionalInfo": {
283
+ "type": "string"
284
+ },
285
+ "copy": {
286
+ "items": {
287
+ "$ref": "#/definitions/ContentTree.transit.Paragraph"
288
+ },
289
+ "type": "array"
290
+ },
291
+ "data": {},
292
+ "image": {
293
+ "$ref": "#/definitions/ContentTree.transit.ImageSet"
294
+ },
295
+ "title": {
296
+ "type": "string"
297
+ },
298
+ "type": {
299
+ "const": "carousel-card",
300
+ "type": "string"
301
+ }
302
+ },
303
+ "required": [
304
+ "copy",
305
+ "image",
306
+ "type"
307
+ ],
308
+ "type": "object"
309
+ },
310
+ "ContentTree.transit.CarouselHeading": {
311
+ "additionalProperties": false,
312
+ "properties": {
313
+ "data": {},
314
+ "standfirst": {
315
+ "type": "string"
316
+ },
317
+ "title": {
318
+ "type": "string"
319
+ },
320
+ "type": {
321
+ "const": "carousel-heading",
322
+ "type": "string"
323
+ }
324
+ },
325
+ "required": [
326
+ "title",
327
+ "type"
328
+ ],
329
+ "type": "object"
330
+ },
249
331
  "ContentTree.transit.ClipSet": {
250
332
  "additionalProperties": false,
251
333
  "properties": {
@@ -1242,60 +1324,7 @@
1242
1324
  "additionalProperties": false,
1243
1325
  "properties": {
1244
1326
  "children": {
1245
- "anyOf": [
1246
- {
1247
- "items": [
1248
- {
1249
- "$ref": "#/definitions/ContentTree.transit.TableCaption"
1250
- },
1251
- {
1252
- "$ref": "#/definitions/ContentTree.transit.TableBody"
1253
- },
1254
- {
1255
- "$ref": "#/definitions/ContentTree.transit.TableFooter"
1256
- }
1257
- ],
1258
- "maxItems": 3,
1259
- "minItems": 3,
1260
- "type": "array"
1261
- },
1262
- {
1263
- "items": [
1264
- {
1265
- "$ref": "#/definitions/ContentTree.transit.TableCaption"
1266
- },
1267
- {
1268
- "$ref": "#/definitions/ContentTree.transit.TableBody"
1269
- }
1270
- ],
1271
- "maxItems": 2,
1272
- "minItems": 2,
1273
- "type": "array"
1274
- },
1275
- {
1276
- "items": [
1277
- {
1278
- "$ref": "#/definitions/ContentTree.transit.TableBody"
1279
- },
1280
- {
1281
- "$ref": "#/definitions/ContentTree.transit.TableFooter"
1282
- }
1283
- ],
1284
- "maxItems": 2,
1285
- "minItems": 2,
1286
- "type": "array"
1287
- },
1288
- {
1289
- "items": [
1290
- {
1291
- "$ref": "#/definitions/ContentTree.transit.TableBody"
1292
- }
1293
- ],
1294
- "maxItems": 1,
1295
- "minItems": 1,
1296
- "type": "array"
1297
- }
1298
- ]
1327
+ "$ref": "#/definitions/ContentTree.transit.TableChildren"
1299
1328
  },
1300
1329
  "collapseAfterHowManyRows": {
1301
1330
  "type": "number"
@@ -1323,7 +1352,6 @@
1323
1352
  },
1324
1353
  "required": [
1325
1354
  "hideOnMobile",
1326
- "sortType",
1327
1355
  "sortable"
1328
1356
  ],
1329
1357
  "type": "object"
@@ -1436,6 +1464,74 @@
1436
1464
  ],
1437
1465
  "type": "object"
1438
1466
  },
1467
+ "ContentTree.transit.TableChildren": {
1468
+ "anyOf": [
1469
+ {
1470
+ "items": [
1471
+ {
1472
+ "$ref": "#/definitions/ContentTree.transit.TableCaption"
1473
+ },
1474
+ {
1475
+ "$ref": "#/definitions/ContentTree.transit.TableBody"
1476
+ },
1477
+ {
1478
+ "$ref": "#/definitions/ContentTree.transit.TableFooter"
1479
+ }
1480
+ ],
1481
+ "maxItems": 3,
1482
+ "minItems": 2,
1483
+ "type": "array"
1484
+ },
1485
+ {
1486
+ "items": [
1487
+ {
1488
+ "$ref": "#/definitions/ContentTree.transit.TableBody"
1489
+ },
1490
+ {
1491
+ "$ref": "#/definitions/ContentTree.transit.TableFooter"
1492
+ }
1493
+ ],
1494
+ "maxItems": 2,
1495
+ "minItems": 1,
1496
+ "type": "array"
1497
+ },
1498
+ {
1499
+ "items": [
1500
+ {
1501
+ "$ref": "#/definitions/ContentTree.transit.TableCaption"
1502
+ },
1503
+ {
1504
+ "$ref": "#/definitions/ContentTree.transit.TableHeader"
1505
+ },
1506
+ {
1507
+ "$ref": "#/definitions/ContentTree.transit.TableBody"
1508
+ },
1509
+ {
1510
+ "$ref": "#/definitions/ContentTree.transit.TableFooter"
1511
+ }
1512
+ ],
1513
+ "maxItems": 4,
1514
+ "minItems": 3,
1515
+ "type": "array"
1516
+ },
1517
+ {
1518
+ "items": [
1519
+ {
1520
+ "$ref": "#/definitions/ContentTree.transit.TableHeader"
1521
+ },
1522
+ {
1523
+ "$ref": "#/definitions/ContentTree.transit.TableBody"
1524
+ },
1525
+ {
1526
+ "$ref": "#/definitions/ContentTree.transit.TableFooter"
1527
+ }
1528
+ ],
1529
+ "maxItems": 3,
1530
+ "minItems": 2,
1531
+ "type": "array"
1532
+ }
1533
+ ]
1534
+ },
1439
1535
  "ContentTree.transit.TableFooter": {
1440
1536
  "additionalProperties": false,
1441
1537
  "properties": {
@@ -1457,6 +1553,27 @@
1457
1553
  ],
1458
1554
  "type": "object"
1459
1555
  },
1556
+ "ContentTree.transit.TableHeader": {
1557
+ "additionalProperties": false,
1558
+ "properties": {
1559
+ "children": {
1560
+ "items": {
1561
+ "$ref": "#/definitions/ContentTree.transit.TableRow"
1562
+ },
1563
+ "type": "array"
1564
+ },
1565
+ "data": {},
1566
+ "type": {
1567
+ "const": "table-header",
1568
+ "type": "string"
1569
+ }
1570
+ },
1571
+ "required": [
1572
+ "children",
1573
+ "type"
1574
+ ],
1575
+ "type": "object"
1576
+ },
1460
1577
  "ContentTree.transit.TableLayoutWidth": {
1461
1578
  "enum": [
1462
1579
  "auto",