@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/transit-tree.schema.json CHANGED
@@ -141,70 +141,73 @@
141
141
  "$ref": "#/definitions/ContentTree.transit.Text"
142
142
  },
143
143
  {
144
- "$ref": "#/definitions/ContentTree.transit.ImageSet"
144
+ "$ref": "#/definitions/ContentTree.transit.AcastPodcast"
145
145
  },
146
146
  {
147
- "$ref": "#/definitions/ContentTree.transit.Flourish"
147
+ "$ref": "#/definitions/ContentTree.transit.BigNumber"
148
148
  },
149
149
  {
150
- "$ref": "#/definitions/ContentTree.transit.BigNumber"
150
+ "$ref": "#/definitions/ContentTree.transit.Carousel"
151
+ },
152
+ {
153
+ "$ref": "#/definitions/ContentTree.transit.ClipSet"
151
154
  },
152
155
  {
153
156
  "$ref": "#/definitions/ContentTree.transit.CustomCodeComponent"
154
157
  },
155
158
  {
156
- "$ref": "#/definitions/ContentTree.transit.Layout"
159
+ "$ref": "#/definitions/ContentTree.transit.Definition"
157
160
  },
158
161
  {
159
- "$ref": "#/definitions/ContentTree.transit.Pullquote"
162
+ "$ref": "#/definitions/ContentTree.transit.Flourish"
160
163
  },
161
164
  {
162
- "$ref": "#/definitions/ContentTree.transit.ScrollyBlock"
165
+ "$ref": "#/definitions/ContentTree.transit.ImagePair"
163
166
  },
164
167
  {
165
- "$ref": "#/definitions/ContentTree.transit.ClipSet"
168
+ "$ref": "#/definitions/ContentTree.transit.ImageSet"
166
169
  },
167
170
  {
168
- "$ref": "#/definitions/ContentTree.transit.Table"
171
+ "$ref": "#/definitions/ContentTree.transit.InfoBox"
169
172
  },
170
173
  {
171
- "$ref": "#/definitions/ContentTree.transit.Recommended"
174
+ "$ref": "#/definitions/ContentTree.transit.InfoPair"
172
175
  },
173
176
  {
174
- "$ref": "#/definitions/ContentTree.transit.RecommendedList"
177
+ "$ref": "#/definitions/ContentTree.transit.InNumbers"
175
178
  },
176
179
  {
177
- "$ref": "#/definitions/ContentTree.transit.Tweet"
180
+ "$ref": "#/definitions/ContentTree.transit.Layout"
178
181
  },
179
182
  {
180
- "$ref": "#/definitions/ContentTree.transit.Video"
183
+ "$ref": "#/definitions/ContentTree.transit.Pullquote"
181
184
  },
182
185
  {
183
- "$ref": "#/definitions/ContentTree.transit.YoutubeVideo"
186
+ "$ref": "#/definitions/ContentTree.transit.Recommended"
184
187
  },
185
188
  {
186
- "$ref": "#/definitions/ContentTree.transit.VimeoVideo"
189
+ "$ref": "#/definitions/ContentTree.transit.RecommendedList"
187
190
  },
188
191
  {
189
- "$ref": "#/definitions/ContentTree.transit.AcastPodcast"
192
+ "$ref": "#/definitions/ContentTree.transit.ScrollyBlock"
190
193
  },
191
194
  {
192
- "$ref": "#/definitions/ContentTree.transit.Timeline"
195
+ "$ref": "#/definitions/ContentTree.transit.Table"
193
196
  },
194
197
  {
195
- "$ref": "#/definitions/ContentTree.transit.ImagePair"
198
+ "$ref": "#/definitions/ContentTree.transit.Timeline"
196
199
  },
197
200
  {
198
- "$ref": "#/definitions/ContentTree.transit.InNumbers"
201
+ "$ref": "#/definitions/ContentTree.transit.Tweet"
199
202
  },
200
203
  {
201
- "$ref": "#/definitions/ContentTree.transit.Definition"
204
+ "$ref": "#/definitions/ContentTree.transit.Video"
202
205
  },
203
206
  {
204
- "$ref": "#/definitions/ContentTree.transit.InfoBox"
207
+ "$ref": "#/definitions/ContentTree.transit.VimeoVideo"
205
208
  },
206
209
  {
207
- "$ref": "#/definitions/ContentTree.transit.InfoPair"
210
+ "$ref": "#/definitions/ContentTree.transit.YoutubeVideo"
208
211
  }
209
212
  ]
210
213
  },
@@ -271,6 +274,84 @@
271
274
  ],
272
275
  "description": "Allowed children for a card"
273
276
  },
277
+ "ContentTree.transit.Carousel": {
278
+ "additionalProperties": false,
279
+ "properties": {
280
+ "children": {
281
+ "items": {
282
+ "$ref": "#/definitions/ContentTree.transit.CarouselCard"
283
+ },
284
+ "maxItems": 10,
285
+ "minItems": 4,
286
+ "type": "array"
287
+ },
288
+ "data": {},
289
+ "heading": {
290
+ "$ref": "#/definitions/ContentTree.transit.CarouselHeading"
291
+ },
292
+ "type": {
293
+ "const": "carousel",
294
+ "type": "string"
295
+ }
296
+ },
297
+ "required": [
298
+ "children",
299
+ "type"
300
+ ],
301
+ "type": "object"
302
+ },
303
+ "ContentTree.transit.CarouselCard": {
304
+ "additionalProperties": false,
305
+ "properties": {
306
+ "additionalInfo": {
307
+ "type": "string"
308
+ },
309
+ "copy": {
310
+ "items": {
311
+ "$ref": "#/definitions/ContentTree.transit.Paragraph"
312
+ },
313
+ "type": "array"
314
+ },
315
+ "data": {},
316
+ "image": {
317
+ "$ref": "#/definitions/ContentTree.transit.ImageSet"
318
+ },
319
+ "title": {
320
+ "type": "string"
321
+ },
322
+ "type": {
323
+ "const": "carousel-card",
324
+ "type": "string"
325
+ }
326
+ },
327
+ "required": [
328
+ "copy",
329
+ "image",
330
+ "type"
331
+ ],
332
+ "type": "object"
333
+ },
334
+ "ContentTree.transit.CarouselHeading": {
335
+ "additionalProperties": false,
336
+ "properties": {
337
+ "data": {},
338
+ "standfirst": {
339
+ "type": "string"
340
+ },
341
+ "title": {
342
+ "type": "string"
343
+ },
344
+ "type": {
345
+ "const": "carousel-heading",
346
+ "type": "string"
347
+ }
348
+ },
349
+ "required": [
350
+ "title",
351
+ "type"
352
+ ],
353
+ "type": "object"
354
+ },
274
355
  "ContentTree.transit.ClipSet": {
275
356
  "additionalProperties": false,
276
357
  "properties": {
@@ -1267,60 +1348,7 @@
1267
1348
  "additionalProperties": false,
1268
1349
  "properties": {
1269
1350
  "children": {
1270
- "anyOf": [
1271
- {
1272
- "items": [
1273
- {
1274
- "$ref": "#/definitions/ContentTree.transit.TableCaption"
1275
- },
1276
- {
1277
- "$ref": "#/definitions/ContentTree.transit.TableBody"
1278
- },
1279
- {
1280
- "$ref": "#/definitions/ContentTree.transit.TableFooter"
1281
- }
1282
- ],
1283
- "maxItems": 3,
1284
- "minItems": 3,
1285
- "type": "array"
1286
- },
1287
- {
1288
- "items": [
1289
- {
1290
- "$ref": "#/definitions/ContentTree.transit.TableCaption"
1291
- },
1292
- {
1293
- "$ref": "#/definitions/ContentTree.transit.TableBody"
1294
- }
1295
- ],
1296
- "maxItems": 2,
1297
- "minItems": 2,
1298
- "type": "array"
1299
- },
1300
- {
1301
- "items": [
1302
- {
1303
- "$ref": "#/definitions/ContentTree.transit.TableBody"
1304
- },
1305
- {
1306
- "$ref": "#/definitions/ContentTree.transit.TableFooter"
1307
- }
1308
- ],
1309
- "maxItems": 2,
1310
- "minItems": 2,
1311
- "type": "array"
1312
- },
1313
- {
1314
- "items": [
1315
- {
1316
- "$ref": "#/definitions/ContentTree.transit.TableBody"
1317
- }
1318
- ],
1319
- "maxItems": 1,
1320
- "minItems": 1,
1321
- "type": "array"
1322
- }
1323
- ]
1351
+ "$ref": "#/definitions/ContentTree.transit.TableChildren"
1324
1352
  },
1325
1353
  "collapseAfterHowManyRows": {
1326
1354
  "type": "number"
@@ -1348,7 +1376,6 @@
1348
1376
  },
1349
1377
  "required": [
1350
1378
  "hideOnMobile",
1351
- "sortType",
1352
1379
  "sortable"
1353
1380
  ],
1354
1381
  "type": "object"
@@ -1461,6 +1488,74 @@
1461
1488
  ],
1462
1489
  "type": "object"
1463
1490
  },
1491
+ "ContentTree.transit.TableChildren": {
1492
+ "anyOf": [
1493
+ {
1494
+ "items": [
1495
+ {
1496
+ "$ref": "#/definitions/ContentTree.transit.TableCaption"
1497
+ },
1498
+ {
1499
+ "$ref": "#/definitions/ContentTree.transit.TableBody"
1500
+ },
1501
+ {
1502
+ "$ref": "#/definitions/ContentTree.transit.TableFooter"
1503
+ }
1504
+ ],
1505
+ "maxItems": 3,
1506
+ "minItems": 2,
1507
+ "type": "array"
1508
+ },
1509
+ {
1510
+ "items": [
1511
+ {
1512
+ "$ref": "#/definitions/ContentTree.transit.TableBody"
1513
+ },
1514
+ {
1515
+ "$ref": "#/definitions/ContentTree.transit.TableFooter"
1516
+ }
1517
+ ],
1518
+ "maxItems": 2,
1519
+ "minItems": 1,
1520
+ "type": "array"
1521
+ },
1522
+ {
1523
+ "items": [
1524
+ {
1525
+ "$ref": "#/definitions/ContentTree.transit.TableCaption"
1526
+ },
1527
+ {
1528
+ "$ref": "#/definitions/ContentTree.transit.TableHeader"
1529
+ },
1530
+ {
1531
+ "$ref": "#/definitions/ContentTree.transit.TableBody"
1532
+ },
1533
+ {
1534
+ "$ref": "#/definitions/ContentTree.transit.TableFooter"
1535
+ }
1536
+ ],
1537
+ "maxItems": 4,
1538
+ "minItems": 3,
1539
+ "type": "array"
1540
+ },
1541
+ {
1542
+ "items": [
1543
+ {
1544
+ "$ref": "#/definitions/ContentTree.transit.TableHeader"
1545
+ },
1546
+ {
1547
+ "$ref": "#/definitions/ContentTree.transit.TableBody"
1548
+ },
1549
+ {
1550
+ "$ref": "#/definitions/ContentTree.transit.TableFooter"
1551
+ }
1552
+ ],
1553
+ "maxItems": 3,
1554
+ "minItems": 2,
1555
+ "type": "array"
1556
+ }
1557
+ ]
1558
+ },
1464
1559
  "ContentTree.transit.TableFooter": {
1465
1560
  "additionalProperties": false,
1466
1561
  "properties": {
@@ -1482,6 +1577,27 @@
1482
1577
  ],
1483
1578
  "type": "object"
1484
1579
  },
1580
+ "ContentTree.transit.TableHeader": {
1581
+ "additionalProperties": false,
1582
+ "properties": {
1583
+ "children": {
1584
+ "items": {
1585
+ "$ref": "#/definitions/ContentTree.transit.TableRow"
1586
+ },
1587
+ "type": "array"
1588
+ },
1589
+ "data": {},
1590
+ "type": {
1591
+ "const": "table-header",
1592
+ "type": "string"
1593
+ }
1594
+ },
1595
+ "required": [
1596
+ "children",
1597
+ "type"
1598
+ ],
1599
+ "type": "object"
1600
+ },
1485
1601
  "ContentTree.transit.TableLayoutWidth": {
1486
1602
  "enum": [
1487
1603
  "auto",