@atlaskit/adf-schema 19.0.0 → 19.2.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 (58) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/dist/cjs/index.js +14 -2
  3. package/dist/cjs/schema/create-schema.js +3 -0
  4. package/dist/cjs/schema/default-schema.js +6 -2
  5. package/dist/cjs/schema/index.js +20 -2
  6. package/dist/cjs/schema/nodes/index.js +22 -2
  7. package/dist/cjs/schema/nodes/layout-section.js +35 -3
  8. package/dist/cjs/schema/nodes/media-inline.js +11 -0
  9. package/dist/cjs/schema/nodes/media.js +8 -3
  10. package/dist/cjs/schema/nodes/tableNodes.js +13 -9
  11. package/dist/cjs/steps/analytics.js +3 -3
  12. package/dist/cjs/steps/type-ahead.js +134 -0
  13. package/dist/cjs/steps.js +14 -0
  14. package/dist/cjs/version.json +1 -1
  15. package/dist/es2019/index.js +1 -1
  16. package/dist/es2019/schema/create-schema.js +4 -1
  17. package/dist/es2019/schema/default-schema.js +5 -2
  18. package/dist/es2019/schema/index.js +1 -1
  19. package/dist/es2019/schema/nodes/index.js +3 -2
  20. package/dist/es2019/schema/nodes/layout-section.js +34 -1
  21. package/dist/es2019/schema/nodes/media-inline.js +2 -0
  22. package/dist/es2019/schema/nodes/media.js +70 -64
  23. package/dist/es2019/schema/nodes/tableNodes.js +10 -9
  24. package/dist/es2019/steps/analytics.js +2 -2
  25. package/dist/es2019/steps/type-ahead.js +85 -0
  26. package/dist/es2019/steps.js +1 -0
  27. package/dist/es2019/version.json +1 -1
  28. package/dist/esm/index.js +1 -1
  29. package/dist/esm/schema/create-schema.js +4 -1
  30. package/dist/esm/schema/default-schema.js +5 -2
  31. package/dist/esm/schema/index.js +1 -1
  32. package/dist/esm/schema/nodes/index.js +3 -2
  33. package/dist/esm/schema/nodes/layout-section.js +32 -1
  34. package/dist/esm/schema/nodes/media-inline.js +2 -0
  35. package/dist/esm/schema/nodes/media.js +8 -3
  36. package/dist/esm/schema/nodes/tableNodes.js +10 -9
  37. package/dist/esm/steps/analytics.js +3 -3
  38. package/dist/esm/steps/type-ahead.js +117 -0
  39. package/dist/esm/steps.js +1 -0
  40. package/dist/esm/version.json +1 -1
  41. package/dist/json-schema/v1/full.json +131 -97
  42. package/dist/json-schema/v1/stage-0.json +225 -97
  43. package/dist/types/index.d.ts +2 -2
  44. package/dist/types/schema/default-schema.d.ts +1 -1
  45. package/dist/types/schema/index.d.ts +2 -2
  46. package/dist/types/schema/nodes/index.d.ts +5 -3
  47. package/dist/types/schema/nodes/layout-section.d.ts +28 -1
  48. package/dist/types/schema/nodes/media-inline.d.ts +16 -0
  49. package/dist/types/schema/nodes/media.d.ts +1 -1
  50. package/dist/types/schema/nodes/tableNodes.d.ts +11 -1
  51. package/dist/types/schema/nodes/types/inline-content.d.ts +2 -1
  52. package/dist/types/steps/type-ahead.d.ts +35 -0
  53. package/dist/types/steps.d.ts +1 -0
  54. package/json-schema/v1/full.json +131 -97
  55. package/json-schema/v1/stage-0.json +225 -97
  56. package/package.json +3 -3
  57. package/test-helpers/schema-builder.ts +3 -0
  58. package/test-helpers/schema.ts +1 -0
package/json-schema/v1/full.json CHANGED
@@ -787,6 +787,95 @@
787
787
  ],
788
788
  "additionalProperties": false
789
789
  },
790
+ "media_node": {
791
+ "type": "object",
792
+ "properties": {
793
+ "type": {
794
+ "enum": [
795
+ "media"
796
+ ]
797
+ },
798
+ "attrs": {
799
+ "anyOf": [
800
+ {
801
+ "type": "object",
802
+ "properties": {
803
+ "type": {
804
+ "enum": [
805
+ "link",
806
+ "file"
807
+ ]
808
+ },
809
+ "id": {
810
+ "type": "string",
811
+ "minLength": 1
812
+ },
813
+ "collection": {
814
+ "type": "string"
815
+ },
816
+ "height": {
817
+ "type": "number"
818
+ },
819
+ "width": {
820
+ "type": "number"
821
+ },
822
+ "occurrenceKey": {
823
+ "type": "string",
824
+ "minLength": 1
825
+ },
826
+ "alt": {
827
+ "type": "string"
828
+ }
829
+ },
830
+ "required": [
831
+ "type",
832
+ "id",
833
+ "collection"
834
+ ],
835
+ "additionalProperties": false
836
+ },
837
+ {
838
+ "type": "object",
839
+ "properties": {
840
+ "type": {
841
+ "enum": [
842
+ "external"
843
+ ]
844
+ },
845
+ "url": {
846
+ "type": "string"
847
+ },
848
+ "alt": {
849
+ "type": "string"
850
+ },
851
+ "width": {
852
+ "type": "number"
853
+ },
854
+ "height": {
855
+ "type": "number"
856
+ }
857
+ },
858
+ "required": [
859
+ "type",
860
+ "url"
861
+ ],
862
+ "additionalProperties": false
863
+ }
864
+ ]
865
+ },
866
+ "marks": {
867
+ "type": "array",
868
+ "items": {
869
+ "$ref": "#/definitions/link_mark"
870
+ }
871
+ }
872
+ },
873
+ "required": [
874
+ "type",
875
+ "attrs"
876
+ ],
877
+ "additionalProperties": false
878
+ },
790
879
  "formatted_text_inline_node": {
791
880
  "allOf": [
792
881
  {
@@ -997,95 +1086,6 @@
997
1086
  ],
998
1087
  "additionalProperties": false
999
1088
  },
1000
- "media_node": {
1001
- "type": "object",
1002
- "properties": {
1003
- "type": {
1004
- "enum": [
1005
- "media"
1006
- ]
1007
- },
1008
- "attrs": {
1009
- "anyOf": [
1010
- {
1011
- "type": "object",
1012
- "properties": {
1013
- "type": {
1014
- "enum": [
1015
- "link",
1016
- "file"
1017
- ]
1018
- },
1019
- "id": {
1020
- "type": "string",
1021
- "minLength": 1
1022
- },
1023
- "collection": {
1024
- "type": "string"
1025
- },
1026
- "height": {
1027
- "type": "number"
1028
- },
1029
- "width": {
1030
- "type": "number"
1031
- },
1032
- "occurrenceKey": {
1033
- "type": "string",
1034
- "minLength": 1
1035
- },
1036
- "alt": {
1037
- "type": "string"
1038
- }
1039
- },
1040
- "required": [
1041
- "type",
1042
- "id",
1043
- "collection"
1044
- ],
1045
- "additionalProperties": false
1046
- },
1047
- {
1048
- "type": "object",
1049
- "properties": {
1050
- "type": {
1051
- "enum": [
1052
- "external"
1053
- ]
1054
- },
1055
- "url": {
1056
- "type": "string"
1057
- },
1058
- "alt": {
1059
- "type": "string"
1060
- },
1061
- "width": {
1062
- "type": "number"
1063
- },
1064
- "height": {
1065
- "type": "number"
1066
- }
1067
- },
1068
- "required": [
1069
- "type",
1070
- "url"
1071
- ],
1072
- "additionalProperties": false
1073
- }
1074
- ]
1075
- },
1076
- "marks": {
1077
- "type": "array",
1078
- "items": {
1079
- "$ref": "#/definitions/link_mark"
1080
- }
1081
- }
1082
- },
1083
- "required": [
1084
- "type",
1085
- "attrs"
1086
- ],
1087
- "additionalProperties": false
1088
- },
1089
1089
  "mediaSingle_node": {
1090
1090
  "type": "object",
1091
1091
  "properties": {
@@ -2368,18 +2368,16 @@
2368
2368
  "layoutSection"
2369
2369
  ]
2370
2370
  },
2371
- "content": {
2371
+ "marks": {
2372
2372
  "type": "array",
2373
2373
  "items": {
2374
- "$ref": "#/definitions/layoutColumn_node"
2375
- },
2376
- "minItems": 2,
2377
- "maxItems": 3
2374
+ "$ref": "#/definitions/breakout_mark"
2375
+ }
2378
2376
  },
2379
- "marks": {
2377
+ "content": {
2380
2378
  "type": "array",
2381
2379
  "items": {
2382
- "$ref": "#/definitions/breakout_mark"
2380
+ "$ref": "#/definitions/layoutColumn_node"
2383
2381
  }
2384
2382
  }
2385
2383
  },
@@ -2389,6 +2387,42 @@
2389
2387
  ],
2390
2388
  "additionalProperties": false
2391
2389
  },
2390
+ "layoutSection_full_node": {
2391
+ "allOf": [
2392
+ {
2393
+ "$ref": "#/definitions/layoutSection_node"
2394
+ },
2395
+ {
2396
+ "type": "object",
2397
+ "properties": {
2398
+ "type": {
2399
+ "enum": [
2400
+ "layoutSection"
2401
+ ]
2402
+ },
2403
+ "marks": {
2404
+ "type": "array",
2405
+ "items": {
2406
+ "$ref": "#/definitions/breakout_mark"
2407
+ }
2408
+ },
2409
+ "content": {
2410
+ "type": "array",
2411
+ "items": {
2412
+ "$ref": "#/definitions/layoutColumn_node"
2413
+ },
2414
+ "minItems": 2,
2415
+ "maxItems": 3
2416
+ }
2417
+ },
2418
+ "required": [
2419
+ "type",
2420
+ "content"
2421
+ ],
2422
+ "additionalProperties": false
2423
+ }
2424
+ ]
2425
+ },
2392
2426
  "doc_node": {
2393
2427
  "type": "object",
2394
2428
  "properties": {
@@ -2485,7 +2519,7 @@
2485
2519
  "$ref": "#/definitions/bodiedExtension_with_marks_node"
2486
2520
  },
2487
2521
  {
2488
- "$ref": "#/definitions/layoutSection_node"
2522
+ "$ref": "#/definitions/layoutSection_full_node"
2489
2523
  }
2490
2524
  ]
2491
2525
  }
package/json-schema/v1/stage-0.json CHANGED
@@ -787,6 +787,147 @@
787
787
  ],
788
788
  "additionalProperties": false
789
789
  },
790
+ "media_node": {
791
+ "type": "object",
792
+ "properties": {
793
+ "type": {
794
+ "enum": [
795
+ "media"
796
+ ]
797
+ },
798
+ "attrs": {
799
+ "anyOf": [
800
+ {
801
+ "type": "object",
802
+ "properties": {
803
+ "type": {
804
+ "enum": [
805
+ "link",
806
+ "file"
807
+ ]
808
+ },
809
+ "id": {
810
+ "type": "string",
811
+ "minLength": 1
812
+ },
813
+ "collection": {
814
+ "type": "string"
815
+ },
816
+ "height": {
817
+ "type": "number"
818
+ },
819
+ "width": {
820
+ "type": "number"
821
+ },
822
+ "occurrenceKey": {
823
+ "type": "string",
824
+ "minLength": 1
825
+ },
826
+ "alt": {
827
+ "type": "string"
828
+ }
829
+ },
830
+ "required": [
831
+ "type",
832
+ "id",
833
+ "collection"
834
+ ],
835
+ "additionalProperties": false
836
+ },
837
+ {
838
+ "type": "object",
839
+ "properties": {
840
+ "type": {
841
+ "enum": [
842
+ "external"
843
+ ]
844
+ },
845
+ "url": {
846
+ "type": "string"
847
+ },
848
+ "alt": {
849
+ "type": "string"
850
+ },
851
+ "width": {
852
+ "type": "number"
853
+ },
854
+ "height": {
855
+ "type": "number"
856
+ }
857
+ },
858
+ "required": [
859
+ "type",
860
+ "url"
861
+ ],
862
+ "additionalProperties": false
863
+ }
864
+ ]
865
+ },
866
+ "marks": {
867
+ "type": "array",
868
+ "items": {
869
+ "$ref": "#/definitions/link_mark"
870
+ }
871
+ }
872
+ },
873
+ "required": [
874
+ "type",
875
+ "attrs"
876
+ ],
877
+ "additionalProperties": false
878
+ },
879
+ "mediaInline_node": {
880
+ "type": "object",
881
+ "properties": {
882
+ "type": {
883
+ "enum": [
884
+ "mediaInline"
885
+ ]
886
+ },
887
+ "attrs": {
888
+ "type": "object",
889
+ "properties": {
890
+ "data": {},
891
+ "id": {
892
+ "type": "string",
893
+ "minLength": 1
894
+ },
895
+ "collection": {
896
+ "type": "string"
897
+ },
898
+ "height": {
899
+ "type": "number"
900
+ },
901
+ "width": {
902
+ "type": "number"
903
+ },
904
+ "occurrenceKey": {
905
+ "type": "string",
906
+ "minLength": 1
907
+ },
908
+ "alt": {
909
+ "type": "string"
910
+ }
911
+ },
912
+ "additionalProperties": false,
913
+ "required": [
914
+ "id",
915
+ "collection"
916
+ ]
917
+ },
918
+ "marks": {
919
+ "type": "array",
920
+ "items": {
921
+ "$ref": "#/definitions/link_mark"
922
+ }
923
+ }
924
+ },
925
+ "required": [
926
+ "type",
927
+ "attrs"
928
+ ],
929
+ "additionalProperties": false
930
+ },
790
931
  "formatted_text_inline_node": {
791
932
  "allOf": [
792
933
  {
@@ -889,6 +1030,9 @@
889
1030
  {
890
1031
  "$ref": "#/definitions/status_node"
891
1032
  },
1033
+ {
1034
+ "$ref": "#/definitions/mediaInline_node"
1035
+ },
892
1036
  {
893
1037
  "$ref": "#/definitions/formatted_text_inline_node"
894
1038
  },
@@ -997,95 +1141,6 @@
997
1141
  ],
998
1142
  "additionalProperties": false
999
1143
  },
1000
- "media_node": {
1001
- "type": "object",
1002
- "properties": {
1003
- "type": {
1004
- "enum": [
1005
- "media"
1006
- ]
1007
- },
1008
- "attrs": {
1009
- "anyOf": [
1010
- {
1011
- "type": "object",
1012
- "properties": {
1013
- "type": {
1014
- "enum": [
1015
- "link",
1016
- "file"
1017
- ]
1018
- },
1019
- "id": {
1020
- "type": "string",
1021
- "minLength": 1
1022
- },
1023
- "collection": {
1024
- "type": "string"
1025
- },
1026
- "height": {
1027
- "type": "number"
1028
- },
1029
- "width": {
1030
- "type": "number"
1031
- },
1032
- "occurrenceKey": {
1033
- "type": "string",
1034
- "minLength": 1
1035
- },
1036
- "alt": {
1037
- "type": "string"
1038
- }
1039
- },
1040
- "required": [
1041
- "type",
1042
- "id",
1043
- "collection"
1044
- ],
1045
- "additionalProperties": false
1046
- },
1047
- {
1048
- "type": "object",
1049
- "properties": {
1050
- "type": {
1051
- "enum": [
1052
- "external"
1053
- ]
1054
- },
1055
- "url": {
1056
- "type": "string"
1057
- },
1058
- "alt": {
1059
- "type": "string"
1060
- },
1061
- "width": {
1062
- "type": "number"
1063
- },
1064
- "height": {
1065
- "type": "number"
1066
- }
1067
- },
1068
- "required": [
1069
- "type",
1070
- "url"
1071
- ],
1072
- "additionalProperties": false
1073
- }
1074
- ]
1075
- },
1076
- "marks": {
1077
- "type": "array",
1078
- "items": {
1079
- "$ref": "#/definitions/link_mark"
1080
- }
1081
- }
1082
- },
1083
- "required": [
1084
- "type",
1085
- "attrs"
1086
- ],
1087
- "additionalProperties": false
1088
- },
1089
1144
  "caption_node": {
1090
1145
  "type": "object",
1091
1146
  "properties": {
@@ -2472,18 +2527,16 @@
2472
2527
  "layoutSection"
2473
2528
  ]
2474
2529
  },
2475
- "content": {
2530
+ "marks": {
2476
2531
  "type": "array",
2477
2532
  "items": {
2478
- "$ref": "#/definitions/layoutColumn_node"
2479
- },
2480
- "minItems": 2,
2481
- "maxItems": 3
2533
+ "$ref": "#/definitions/breakout_mark"
2534
+ }
2482
2535
  },
2483
- "marks": {
2536
+ "content": {
2484
2537
  "type": "array",
2485
2538
  "items": {
2486
- "$ref": "#/definitions/breakout_mark"
2539
+ "$ref": "#/definitions/layoutColumn_node"
2487
2540
  }
2488
2541
  }
2489
2542
  },
@@ -2493,6 +2546,78 @@
2493
2546
  ],
2494
2547
  "additionalProperties": false
2495
2548
  },
2549
+ "layoutSection_full_node": {
2550
+ "allOf": [
2551
+ {
2552
+ "$ref": "#/definitions/layoutSection_node"
2553
+ },
2554
+ {
2555
+ "type": "object",
2556
+ "properties": {
2557
+ "type": {
2558
+ "enum": [
2559
+ "layoutSection"
2560
+ ]
2561
+ },
2562
+ "marks": {
2563
+ "type": "array",
2564
+ "items": {
2565
+ "$ref": "#/definitions/breakout_mark"
2566
+ }
2567
+ },
2568
+ "content": {
2569
+ "type": "array",
2570
+ "items": {
2571
+ "$ref": "#/definitions/layoutColumn_node"
2572
+ },
2573
+ "minItems": 2,
2574
+ "maxItems": 3
2575
+ }
2576
+ },
2577
+ "required": [
2578
+ "type",
2579
+ "content"
2580
+ ],
2581
+ "additionalProperties": false
2582
+ }
2583
+ ]
2584
+ },
2585
+ "layoutSection_with_single_column_node": {
2586
+ "allOf": [
2587
+ {
2588
+ "$ref": "#/definitions/layoutSection_node"
2589
+ },
2590
+ {
2591
+ "type": "object",
2592
+ "properties": {
2593
+ "type": {
2594
+ "enum": [
2595
+ "layoutSection"
2596
+ ]
2597
+ },
2598
+ "marks": {
2599
+ "type": "array",
2600
+ "items": {
2601
+ "$ref": "#/definitions/breakout_mark"
2602
+ }
2603
+ },
2604
+ "content": {
2605
+ "type": "array",
2606
+ "items": {
2607
+ "$ref": "#/definitions/layoutColumn_node"
2608
+ },
2609
+ "minItems": 1,
2610
+ "maxItems": 3
2611
+ }
2612
+ },
2613
+ "required": [
2614
+ "type",
2615
+ "content"
2616
+ ],
2617
+ "additionalProperties": false
2618
+ }
2619
+ ]
2620
+ },
2496
2621
  "doc_node": {
2497
2622
  "type": "object",
2498
2623
  "properties": {
@@ -2592,7 +2717,10 @@
2592
2717
  "$ref": "#/definitions/bodiedExtension_with_marks_node"
2593
2718
  },
2594
2719
  {
2595
- "$ref": "#/definitions/layoutSection_node"
2720
+ "$ref": "#/definitions/layoutSection_full_node"
2721
+ },
2722
+ {
2723
+ "$ref": "#/definitions/layoutSection_with_single_column_node"
2596
2724
  }
2597
2725
  ]
2598
2726
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/adf-schema",
3
- "version": "19.0.0",
3
+ "version": "19.2.2",
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/"
@@ -35,13 +35,13 @@
35
35
  "@types/prosemirror-state": "^1.2.0",
36
36
  "css-color-names": "0.0.4",
37
37
  "linkify-it": "^2.0.3",
38
- "memoize-one": "^5.1.0",
38
+ "memoize-one": "^6.0.0",
39
39
  "prosemirror-model": "1.11.0",
40
40
  "prosemirror-transform": "1.2.8"
41
41
  },
42
42
  "devDependencies": {
43
43
  "@atlaskit/editor-json-transformer": "^8.6.0",
44
- "@atlaskit/editor-test-helpers": "^15.3.0",
44
+ "@atlaskit/editor-test-helpers": "^15.4.0",
45
45
  "@atlaskit/json-schema-generator": "^3.1.0",
46
46
  "@atlassian/adf-sample": "^1.0.0",
47
47
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
package/test-helpers/schema-builder.ts CHANGED
@@ -7,6 +7,7 @@ import {
7
7
  Slice /*MediaAttributes */,
8
8
  } from 'prosemirror-model';
9
9
  import { MediaAttributes } from '../src/schema/nodes/media';
10
+ import { MediaInlineAttributes } from '../src/schema/nodes/media-inline';
10
11
  import matches from './matches';
11
12
  import sampleSchema from './schema';
12
13
  import {
@@ -288,6 +289,8 @@ export const slice = (...content: BuilderContent[]) =>
288
289
  export const mediaSingle = (attrs = {}) =>
289
290
  nodeFactory(sampleSchema.nodes.mediaSingle, attrs);
290
291
  export const mediaGroup = nodeFactory(sampleSchema.nodes.mediaGroup);
292
+ export const mediaInline = (attrs: MediaInlineAttributes) =>
293
+ sampleSchema.nodes.media.create(attrs);
291
294
  export const media = (attrs: MediaAttributes) =>
292
295
  sampleSchema.nodes.media.create(attrs);
293
296
  export const textColor = (attrs: { color: string }) =>
package/test-helpers/schema.ts CHANGED
@@ -30,6 +30,7 @@ export default createSchema({
30
30
  'caption',
31
31
  'media',
32
32
  'mediaGroup',
33
+ 'mediaInline',
33
34
  'confluenceUnsupportedBlock',
34
35
  'confluenceUnsupportedInline',
35
36
  'confluenceJiraIssue',