@atlaskit/adf-schema 25.3.1 → 25.4.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.
Files changed (47) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/dist/cjs/index.js +12 -0
  3. package/dist/cjs/schema/create-schema.js +3 -0
  4. package/dist/cjs/schema/default-schema.js +4 -0
  5. package/dist/cjs/schema/index.js +12 -0
  6. package/dist/cjs/schema/marks/border.js +52 -0
  7. package/dist/cjs/schema/marks/index.js +14 -1
  8. package/dist/cjs/schema/nodes/media-group.js +4 -1
  9. package/dist/cjs/schema/nodes/media-single.js +3 -3
  10. package/dist/cjs/schema/nodes/tableNodes.js +6 -1
  11. package/dist/cjs/utils/colors.js +7 -1
  12. package/dist/cjs/version.json +1 -1
  13. package/dist/es2019/index.js +1 -1
  14. package/dist/es2019/schema/create-schema.js +4 -1
  15. package/dist/es2019/schema/default-schema.js +4 -0
  16. package/dist/es2019/schema/index.js +1 -1
  17. package/dist/es2019/schema/marks/border.js +37 -0
  18. package/dist/es2019/schema/marks/index.js +2 -1
  19. package/dist/es2019/schema/nodes/media-group.js +4 -1
  20. package/dist/es2019/schema/nodes/media-single.js +3 -3
  21. package/dist/es2019/schema/nodes/tableNodes.js +6 -1
  22. package/dist/es2019/utils/colors.js +3 -0
  23. package/dist/es2019/version.json +1 -1
  24. package/dist/esm/index.js +1 -1
  25. package/dist/esm/schema/create-schema.js +4 -1
  26. package/dist/esm/schema/default-schema.js +4 -0
  27. package/dist/esm/schema/index.js +1 -1
  28. package/dist/esm/schema/marks/border.js +43 -0
  29. package/dist/esm/schema/marks/index.js +2 -1
  30. package/dist/esm/schema/nodes/media-group.js +4 -1
  31. package/dist/esm/schema/nodes/media-single.js +3 -3
  32. package/dist/esm/schema/nodes/tableNodes.js +6 -1
  33. package/dist/esm/utils/colors.js +3 -0
  34. package/dist/esm/version.json +1 -1
  35. package/dist/json-schema/v1/full.json +29 -29
  36. package/dist/json-schema/v1/stage-0.json +71 -30
  37. package/dist/types/index.d.ts +2 -2
  38. package/dist/types/schema/index.d.ts +2 -2
  39. package/dist/types/schema/marks/border.d.ts +24 -0
  40. package/dist/types/schema/marks/index.d.ts +2 -0
  41. package/dist/types/schema/nodes/media-single.d.ts +10 -10
  42. package/dist/types/schema/nodes/media.d.ts +2 -1
  43. package/dist/types/utils/colors.d.ts +3 -0
  44. package/json-schema/v1/full.json +29 -29
  45. package/json-schema/v1/stage-0.json +71 -30
  46. package/package.json +5 -4
  47. package/report.api.md +25 -1
@@ -1238,7 +1238,7 @@
1238
1238
  ],
1239
1239
  "additionalProperties": true
1240
1240
  },
1241
- "mediaSingle_full_node": {
1241
+ "mediaSingle_caption_node": {
1242
1242
  "allOf": [
1243
1243
  {
1244
1244
  "$ref": "#/definitions/mediaSingle_node"
@@ -1248,11 +1248,16 @@
1248
1248
  "properties": {
1249
1249
  "content": {
1250
1250
  "type": "array",
1251
- "items": {
1252
- "$ref": "#/definitions/media_node"
1253
- },
1251
+ "items": [
1252
+ {
1253
+ "$ref": "#/definitions/media_node"
1254
+ },
1255
+ {
1256
+ "$ref": "#/definitions/caption_node"
1257
+ }
1258
+ ],
1254
1259
  "minItems": 1,
1255
- "maxItems": 1
1260
+ "maxItems": 2
1256
1261
  }
1257
1262
  },
1258
1263
  "required": [
@@ -1262,7 +1267,7 @@
1262
1267
  }
1263
1268
  ]
1264
1269
  },
1265
- "mediaSingle_caption_node": {
1270
+ "mediaSingle_full_node": {
1266
1271
  "allOf": [
1267
1272
  {
1268
1273
  "$ref": "#/definitions/mediaSingle_node"
@@ -1272,16 +1277,11 @@
1272
1277
  "properties": {
1273
1278
  "content": {
1274
1279
  "type": "array",
1275
- "items": [
1276
- {
1277
- "$ref": "#/definitions/media_node"
1278
- },
1279
- {
1280
- "$ref": "#/definitions/caption_node"
1281
- }
1282
- ],
1280
+ "items": {
1281
+ "$ref": "#/definitions/media_node"
1282
+ },
1283
1283
  "minItems": 1,
1284
- "maxItems": 2
1284
+ "maxItems": 1
1285
1285
  }
1286
1286
  },
1287
1287
  "required": [
@@ -1311,10 +1311,10 @@
1311
1311
  "$ref": "#/definitions/paragraph_with_no_marks_node"
1312
1312
  },
1313
1313
  {
1314
- "$ref": "#/definitions/mediaSingle_full_node"
1314
+ "$ref": "#/definitions/mediaSingle_caption_node"
1315
1315
  },
1316
1316
  {
1317
- "$ref": "#/definitions/mediaSingle_caption_node"
1317
+ "$ref": "#/definitions/mediaSingle_full_node"
1318
1318
  }
1319
1319
  ]
1320
1320
  },
@@ -1327,10 +1327,10 @@
1327
1327
  "$ref": "#/definitions/paragraph_with_no_marks_node"
1328
1328
  },
1329
1329
  {
1330
- "$ref": "#/definitions/mediaSingle_full_node"
1330
+ "$ref": "#/definitions/mediaSingle_caption_node"
1331
1331
  },
1332
1332
  {
1333
- "$ref": "#/definitions/mediaSingle_caption_node"
1333
+ "$ref": "#/definitions/mediaSingle_full_node"
1334
1334
  },
1335
1335
  {
1336
1336
  "$ref": "#/definitions/bulletList_node"
@@ -1920,10 +1920,10 @@
1920
1920
  "$ref": "#/definitions/paragraph_with_no_marks_node"
1921
1921
  },
1922
1922
  {
1923
- "$ref": "#/definitions/mediaSingle_full_node"
1923
+ "$ref": "#/definitions/mediaSingle_caption_node"
1924
1924
  },
1925
1925
  {
1926
- "$ref": "#/definitions/mediaSingle_caption_node"
1926
+ "$ref": "#/definitions/mediaSingle_full_node"
1927
1927
  },
1928
1928
  {
1929
1929
  "$ref": "#/definitions/heading_with_no_marks_node"
@@ -2073,10 +2073,10 @@
2073
2073
  "$ref": "#/definitions/paragraph_with_alignment_node"
2074
2074
  },
2075
2075
  {
2076
- "$ref": "#/definitions/mediaSingle_full_node"
2076
+ "$ref": "#/definitions/mediaSingle_caption_node"
2077
2077
  },
2078
2078
  {
2079
- "$ref": "#/definitions/mediaSingle_caption_node"
2079
+ "$ref": "#/definitions/mediaSingle_full_node"
2080
2080
  },
2081
2081
  {
2082
2082
  "$ref": "#/definitions/bulletList_node"
@@ -2214,10 +2214,10 @@
2214
2214
  "$ref": "#/definitions/paragraph_with_no_marks_node"
2215
2215
  },
2216
2216
  {
2217
- "$ref": "#/definitions/mediaSingle_full_node"
2217
+ "$ref": "#/definitions/mediaSingle_caption_node"
2218
2218
  },
2219
2219
  {
2220
- "$ref": "#/definitions/mediaSingle_caption_node"
2220
+ "$ref": "#/definitions/mediaSingle_full_node"
2221
2221
  },
2222
2222
  {
2223
2223
  "$ref": "#/definitions/bulletList_node"
@@ -2431,10 +2431,10 @@
2431
2431
  "$ref": "#/definitions/paragraph_with_indentation_node"
2432
2432
  },
2433
2433
  {
2434
- "$ref": "#/definitions/mediaSingle_full_node"
2434
+ "$ref": "#/definitions/mediaSingle_caption_node"
2435
2435
  },
2436
2436
  {
2437
- "$ref": "#/definitions/mediaSingle_caption_node"
2437
+ "$ref": "#/definitions/mediaSingle_full_node"
2438
2438
  },
2439
2439
  {
2440
2440
  "$ref": "#/definitions/bulletList_node"
@@ -2622,10 +2622,10 @@
2622
2622
  "$ref": "#/definitions/paragraph_with_indentation_node"
2623
2623
  },
2624
2624
  {
2625
- "$ref": "#/definitions/mediaSingle_full_node"
2625
+ "$ref": "#/definitions/mediaSingle_caption_node"
2626
2626
  },
2627
2627
  {
2628
- "$ref": "#/definitions/mediaSingle_caption_node"
2628
+ "$ref": "#/definitions/mediaSingle_full_node"
2629
2629
  },
2630
2630
  {
2631
2631
  "$ref": "#/definitions/bulletList_node"
@@ -458,6 +458,40 @@
458
458
  ],
459
459
  "additionalProperties": false
460
460
  },
461
+ "border_mark": {
462
+ "type": "object",
463
+ "properties": {
464
+ "type": {
465
+ "enum": [
466
+ "border"
467
+ ]
468
+ },
469
+ "attrs": {
470
+ "type": "object",
471
+ "properties": {
472
+ "size": {
473
+ "type": "number",
474
+ "minimum": 1,
475
+ "maximum": 3
476
+ },
477
+ "color": {
478
+ "type": "string",
479
+ "pattern": "^#[0-9a-fA-F]{8}$|^#[0-9a-fA-F]{6}$"
480
+ }
481
+ },
482
+ "required": [
483
+ "size",
484
+ "color"
485
+ ],
486
+ "additionalProperties": false
487
+ }
488
+ },
489
+ "required": [
490
+ "type",
491
+ "attrs"
492
+ ],
493
+ "additionalProperties": false
494
+ },
461
495
  "hardBreak_node": {
462
496
  "type": "object",
463
497
  "properties": {
@@ -887,7 +921,14 @@
887
921
  "marks": {
888
922
  "type": "array",
889
923
  "items": {
890
- "$ref": "#/definitions/link_mark"
924
+ "anyOf": [
925
+ {
926
+ "$ref": "#/definitions/link_mark"
927
+ },
928
+ {
929
+ "$ref": "#/definitions/border_mark"
930
+ }
931
+ ]
891
932
  }
892
933
  }
893
934
  },
@@ -1238,7 +1279,7 @@
1238
1279
  ],
1239
1280
  "additionalProperties": true
1240
1281
  },
1241
- "mediaSingle_full_node": {
1282
+ "mediaSingle_caption_node": {
1242
1283
  "allOf": [
1243
1284
  {
1244
1285
  "$ref": "#/definitions/mediaSingle_node"
@@ -1248,11 +1289,16 @@
1248
1289
  "properties": {
1249
1290
  "content": {
1250
1291
  "type": "array",
1251
- "items": {
1252
- "$ref": "#/definitions/media_node"
1253
- },
1292
+ "items": [
1293
+ {
1294
+ "$ref": "#/definitions/media_node"
1295
+ },
1296
+ {
1297
+ "$ref": "#/definitions/caption_node"
1298
+ }
1299
+ ],
1254
1300
  "minItems": 1,
1255
- "maxItems": 1
1301
+ "maxItems": 2
1256
1302
  }
1257
1303
  },
1258
1304
  "required": [
@@ -1262,7 +1308,7 @@
1262
1308
  }
1263
1309
  ]
1264
1310
  },
1265
- "mediaSingle_caption_node": {
1311
+ "mediaSingle_full_node": {
1266
1312
  "allOf": [
1267
1313
  {
1268
1314
  "$ref": "#/definitions/mediaSingle_node"
@@ -1272,16 +1318,11 @@
1272
1318
  "properties": {
1273
1319
  "content": {
1274
1320
  "type": "array",
1275
- "items": [
1276
- {
1277
- "$ref": "#/definitions/media_node"
1278
- },
1279
- {
1280
- "$ref": "#/definitions/caption_node"
1281
- }
1282
- ],
1321
+ "items": {
1322
+ "$ref": "#/definitions/media_node"
1323
+ },
1283
1324
  "minItems": 1,
1284
- "maxItems": 2
1325
+ "maxItems": 1
1285
1326
  }
1286
1327
  },
1287
1328
  "required": [
@@ -1311,10 +1352,10 @@
1311
1352
  "$ref": "#/definitions/paragraph_with_no_marks_node"
1312
1353
  },
1313
1354
  {
1314
- "$ref": "#/definitions/mediaSingle_full_node"
1355
+ "$ref": "#/definitions/mediaSingle_caption_node"
1315
1356
  },
1316
1357
  {
1317
- "$ref": "#/definitions/mediaSingle_caption_node"
1358
+ "$ref": "#/definitions/mediaSingle_full_node"
1318
1359
  }
1319
1360
  ]
1320
1361
  },
@@ -1327,10 +1368,10 @@
1327
1368
  "$ref": "#/definitions/paragraph_with_no_marks_node"
1328
1369
  },
1329
1370
  {
1330
- "$ref": "#/definitions/mediaSingle_full_node"
1371
+ "$ref": "#/definitions/mediaSingle_caption_node"
1331
1372
  },
1332
1373
  {
1333
- "$ref": "#/definitions/mediaSingle_caption_node"
1374
+ "$ref": "#/definitions/mediaSingle_full_node"
1334
1375
  },
1335
1376
  {
1336
1377
  "$ref": "#/definitions/bulletList_node"
@@ -1920,10 +1961,10 @@
1920
1961
  "$ref": "#/definitions/paragraph_with_no_marks_node"
1921
1962
  },
1922
1963
  {
1923
- "$ref": "#/definitions/mediaSingle_full_node"
1964
+ "$ref": "#/definitions/mediaSingle_caption_node"
1924
1965
  },
1925
1966
  {
1926
- "$ref": "#/definitions/mediaSingle_caption_node"
1967
+ "$ref": "#/definitions/mediaSingle_full_node"
1927
1968
  },
1928
1969
  {
1929
1970
  "$ref": "#/definitions/heading_with_no_marks_node"
@@ -2073,10 +2114,10 @@
2073
2114
  "$ref": "#/definitions/paragraph_with_alignment_node"
2074
2115
  },
2075
2116
  {
2076
- "$ref": "#/definitions/mediaSingle_full_node"
2117
+ "$ref": "#/definitions/mediaSingle_caption_node"
2077
2118
  },
2078
2119
  {
2079
- "$ref": "#/definitions/mediaSingle_caption_node"
2120
+ "$ref": "#/definitions/mediaSingle_full_node"
2080
2121
  },
2081
2122
  {
2082
2123
  "$ref": "#/definitions/bulletList_node"
@@ -2214,10 +2255,10 @@
2214
2255
  "$ref": "#/definitions/paragraph_with_no_marks_node"
2215
2256
  },
2216
2257
  {
2217
- "$ref": "#/definitions/mediaSingle_full_node"
2258
+ "$ref": "#/definitions/mediaSingle_caption_node"
2218
2259
  },
2219
2260
  {
2220
- "$ref": "#/definitions/mediaSingle_caption_node"
2261
+ "$ref": "#/definitions/mediaSingle_full_node"
2221
2262
  },
2222
2263
  {
2223
2264
  "$ref": "#/definitions/bulletList_node"
@@ -2431,10 +2472,10 @@
2431
2472
  "$ref": "#/definitions/paragraph_with_indentation_node"
2432
2473
  },
2433
2474
  {
2434
- "$ref": "#/definitions/mediaSingle_full_node"
2475
+ "$ref": "#/definitions/mediaSingle_caption_node"
2435
2476
  },
2436
2477
  {
2437
- "$ref": "#/definitions/mediaSingle_caption_node"
2478
+ "$ref": "#/definitions/mediaSingle_full_node"
2438
2479
  },
2439
2480
  {
2440
2481
  "$ref": "#/definitions/bulletList_node"
@@ -2658,10 +2699,10 @@
2658
2699
  "$ref": "#/definitions/paragraph_with_indentation_node"
2659
2700
  },
2660
2701
  {
2661
- "$ref": "#/definitions/mediaSingle_full_node"
2702
+ "$ref": "#/definitions/mediaSingle_caption_node"
2662
2703
  },
2663
2704
  {
2664
- "$ref": "#/definitions/mediaSingle_caption_node"
2705
+ "$ref": "#/definitions/mediaSingle_full_node"
2665
2706
  },
2666
2707
  {
2667
2708
  "$ref": "#/definitions/bulletList_node"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/adf-schema",
3
- "version": "25.3.1",
3
+ "version": "25.4.0",
4
4
  "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -40,8 +40,9 @@
40
40
  },
41
41
  "dependencies": {
42
42
  "@atlaskit/codemod-utils": "^4.1.0",
43
- "@atlaskit/editor-palette": "1.0.0",
43
+ "@atlaskit/editor-palette": "1.2.0",
44
44
  "@atlaskit/editor-tables": "^2.2.0",
45
+ "@atlaskit/tokens": "^1.2.1",
45
46
  "@babel/runtime": "^7.0.0",
46
47
  "@types/linkify-it": "^2.0.4",
47
48
  "@types/prosemirror-model": "^1.11.0",
@@ -53,9 +54,9 @@
53
54
  "prosemirror-transform": "1.3.2"
54
55
  },
55
56
  "devDependencies": {
56
- "@atlaskit/adf-utils": "^18.0.0",
57
+ "@atlaskit/adf-utils": "^18.1.0",
57
58
  "@atlaskit/editor-json-transformer": "^8.8.0",
58
- "@atlaskit/editor-test-helpers": "^18.0.0",
59
+ "@atlaskit/editor-test-helpers": "^18.2.0",
59
60
  "@atlaskit/json-schema-generator": "^3.3.0",
60
61
  "@atlassian/adf-sample": "^1.1.0",
61
62
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
package/report.api.md CHANGED
@@ -206,6 +206,29 @@ interface BodiedExtensionBaseDefinition {
206
206
  export type BodiedExtensionDefinition = BodiedExtensionBaseDefinition &
207
207
  MarksObject<DataConsumerDefinition | FragmentDefinition>;
208
208
 
209
+ // @public (undocumented)
210
+ export const border: MarkSpec;
211
+
212
+ // @public (undocumented)
213
+ type BorderColorKey = 'Bold gray' | 'Gray' | 'Subtle gray';
214
+
215
+ // @public (undocumented)
216
+ export const borderColorPalette: Map<string, BorderColorKey>;
217
+
218
+ // @public (undocumented)
219
+ export type BorderMarkAttributes = {
220
+ size: number;
221
+ color: string;
222
+ };
223
+
224
+ // @public
225
+ export interface BorderMarkDefinition {
226
+ // (undocumented)
227
+ attrs: BorderMarkAttributes;
228
+ // (undocumented)
229
+ type: 'border';
230
+ }
231
+
209
232
  // @public (undocumented)
210
233
  export const breakout: MarkSpec;
211
234
 
@@ -281,6 +304,7 @@ export type CellDomAttrs = {
281
304
  style?: string;
282
305
  colorname?: string;
283
306
  'data-colwidth'?: string;
307
+ 'data-cell-background'?: string;
284
308
  class?: string;
285
309
  };
286
310
 
@@ -1026,7 +1050,7 @@ export interface MediaDefinition {
1026
1050
  // (undocumented)
1027
1051
  attrs: MediaADFAttrs;
1028
1052
  // (undocumented)
1029
- marks?: Array<LinkDefinition>;
1053
+ marks?: Array<BorderMarkDefinition | LinkDefinition>;
1030
1054
  // (undocumented)
1031
1055
  type: 'media';
1032
1056
  }