@atlaskit/editor-core 192.7.0 → 193.0.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 (35) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/cjs/create-editor/create-plugins-list.js +0 -1
  3. package/dist/cjs/preset-universal.js +8 -1
  4. package/dist/cjs/presets/default.js +1 -2
  5. package/dist/cjs/presets/universal.js +1 -1
  6. package/dist/cjs/ui/Addon/ClickAreaBlock/index.js +5 -3
  7. package/dist/cjs/ui/Addon/ClickAreaInline/index.js +4 -3
  8. package/dist/cjs/version-wrapper.js +1 -1
  9. package/dist/es2019/create-editor/create-plugins-list.js +0 -1
  10. package/dist/es2019/preset-universal.js +2 -1
  11. package/dist/es2019/presets/default.js +1 -2
  12. package/dist/es2019/presets/universal.js +1 -1
  13. package/dist/es2019/ui/Addon/ClickAreaBlock/index.js +4 -4
  14. package/dist/es2019/ui/Addon/ClickAreaInline/index.js +3 -3
  15. package/dist/es2019/version-wrapper.js +1 -1
  16. package/dist/esm/create-editor/create-plugins-list.js +0 -1
  17. package/dist/esm/preset-universal.js +2 -1
  18. package/dist/esm/presets/default.js +1 -2
  19. package/dist/esm/presets/universal.js +1 -1
  20. package/dist/esm/ui/Addon/ClickAreaBlock/index.js +4 -3
  21. package/dist/esm/ui/Addon/ClickAreaInline/index.js +3 -3
  22. package/dist/esm/version-wrapper.js +1 -1
  23. package/dist/types/create-editor/create-preset.d.ts +70 -70
  24. package/dist/types/preset-universal.d.ts +1 -0
  25. package/dist/types/presets/default.d.ts +28 -164
  26. package/dist/types/presets/universal.d.ts +70 -70
  27. package/dist/types/presets/useUniversalPreset.d.ts +70 -70
  28. package/dist/types-ts4.5/create-editor/create-preset.d.ts +82 -82
  29. package/dist/types-ts4.5/preset-universal.d.ts +1 -0
  30. package/dist/types-ts4.5/presets/default.d.ts +24 -190
  31. package/dist/types-ts4.5/presets/universal.d.ts +82 -82
  32. package/dist/types-ts4.5/presets/useUniversalPreset.d.ts +82 -82
  33. package/docs/4-annotations.tsx +1 -1
  34. package/package.json +21 -8
  35. package/docs/editor-use-only.tsx +0 -50
@@ -39,6 +39,7 @@ export default function useUniversalPreset({ props }: PresetProps): import("@atl
39
39
  import("@atlaskit/editor-common/types").MaybePluginName<"mention">,
40
40
  import("@atlaskit/editor-common/types").MaybePluginName<"caption">,
41
41
  import("@atlaskit/editor-common/types").MaybePluginName<"media">,
42
+ import("@atlaskit/editor-common/types").MaybePluginName<"annotation">,
42
43
  import("@atlaskit/editor-common/types").MaybePluginName<"grid">,
43
44
  import("@atlaskit/editor-common/types").MaybePluginName<"guideline">,
44
45
  import("@atlaskit/editor-common/types").MaybePluginName<"expand">,
@@ -62,7 +63,6 @@ export default function useUniversalPreset({ props }: PresetProps): import("@atl
62
63
  "textFormatting",
63
64
  "hyperlink",
64
65
  import("@atlaskit/editor-common/types").MaybePluginName<"selectionToolbar">,
65
- import("@atlaskit/editor-common/types").MaybePluginName<"annotation">,
66
66
  "clearMarksOnEmptyDoc",
67
67
  "blockType",
68
68
  import("@atlaskit/editor-common/types").MaybePluginName<"undoRedoPlugin">,
@@ -2923,6 +2923,87 @@ export default function useUniversalPreset({ props }: PresetProps): import("@atl
2923
2923
  insertMediaAsMediaSingle: import("@atlaskit/editor-plugins/media/types").InsertMediaAsMediaSingle;
2924
2924
  };
2925
2925
  }, import("@atlaskit/editor-plugins/media/types").MediaOptions | undefined>>,
2926
+ import("@atlaskit/editor-common/types").MaybePlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"annotation", {
2927
+ pluginConfiguration: import("@atlaskit/editor-plugin-annotation").AnnotationProviders | undefined;
2928
+ sharedState: import("@atlaskit/editor-plugin-annotation").InlineCommentPluginState | undefined;
2929
+ dependencies: [
2930
+ import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {
2931
+ pluginConfiguration: import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions;
2932
+ sharedState: {
2933
+ createAnalyticsEvent: import("@atlaskit/analytics-next").CreateUIAnalyticsEvent | null;
2934
+ attachAnalyticsEvent: import("@atlaskit/editor-plugin-analytics").CreateAttachPayloadIntoTransaction | null;
2935
+ performanceTracking: import("@atlaskit/editor-common/types").PerformanceTracking | undefined;
2936
+ };
2937
+ dependencies: [
2938
+ import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
2939
+ pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
2940
+ sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
2941
+ }, import("@atlaskit/editor-common/types").FeatureFlags>>
2942
+ ];
2943
+ actions: import("@atlaskit/editor-common/analytics").EditorAnalyticsAPI;
2944
+ }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>,
2945
+ import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"editorViewMode", {
2946
+ sharedState: import("@atlaskit/editor-plugin-editor-viewmode").EditorViewModePluginState | null;
2947
+ dependencies: [
2948
+ import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"collabEdit", {
2949
+ pluginConfiguration: import("@atlaskit/editor-plugin-collab-edit").PrivateCollabEditOptions;
2950
+ dependencies: [
2951
+ import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
2952
+ pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
2953
+ sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
2954
+ }, import("@atlaskit/editor-common/types").FeatureFlags>>,
2955
+ import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {
2956
+ pluginConfiguration: import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions;
2957
+ sharedState: {
2958
+ createAnalyticsEvent: import("@atlaskit/analytics-next").CreateUIAnalyticsEvent | null;
2959
+ attachAnalyticsEvent: import("@atlaskit/editor-plugin-analytics").CreateAttachPayloadIntoTransaction | null;
2960
+ performanceTracking: import("@atlaskit/editor-common/types").PerformanceTracking | undefined;
2961
+ };
2962
+ dependencies: [
2963
+ import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
2964
+ pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
2965
+ sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
2966
+ }, import("@atlaskit/editor-common/types").FeatureFlags>>
2967
+ ];
2968
+ actions: import("@atlaskit/editor-common/analytics").EditorAnalyticsAPI;
2969
+ }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>
2970
+ ];
2971
+ sharedState: import("@atlaskit/editor-plugin-collab-edit").CollabEditPluginSharedState;
2972
+ actions: {
2973
+ getAvatarColor: (str: string) => {
2974
+ index: number;
2975
+ color: import("@atlaskit/editor-common/collab").Color;
2976
+ };
2977
+ addInlineCommentMark: (props: {
2978
+ from: number;
2979
+ to: number;
2980
+ mark: import("prosemirror-model").Mark;
2981
+ }) => boolean;
2982
+ };
2983
+ }, import("@atlaskit/editor-plugin-collab-edit").PrivateCollabEditOptions>
2984
+ ];
2985
+ pluginConfiguration?: {
2986
+ mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
2987
+ } | undefined;
2988
+ commands: {
2989
+ updateViewMode: (mode: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode) => import("@atlaskit/editor-common/types").EditorCommand;
2990
+ };
2991
+ actions: {
2992
+ applyViewModeStepAt: (tr: import("prosemirror-state").Transaction) => boolean;
2993
+ };
2994
+ }, {
2995
+ mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
2996
+ } | undefined>>,
2997
+ import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
2998
+ pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
2999
+ sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
3000
+ }, import("@atlaskit/editor-common/types").FeatureFlags>>
3001
+ ];
3002
+ actions: {
3003
+ stripNonExistingAnnotations: (slice: import("prosemirror-model").Slice, state: import("prosemirror-state").EditorState) => boolean | undefined;
3004
+ setInlineCommentDraftState: (drafting: boolean, inputMethod: import("@atlaskit/editor-plugin-annotation").InlineCommentInputMethod, targetType?: import("@atlaskit/editor-plugin-annotation").TargetType | undefined, isCommentOnMediaOn?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
3005
+ };
3006
+ }, import("@atlaskit/editor-plugin-annotation").AnnotationProviders | undefined>>,
2926
3007
  import("@atlaskit/editor-common/types").MaybePlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"grid", {
2927
3008
  pluginConfiguration: import("@atlaskit/editor-plugin-grid").GridPluginOptions | undefined;
2928
3009
  dependencies: [
@@ -3896,87 +3977,6 @@ export default function useUniversalPreset({ props }: PresetProps): import("@atl
3896
3977
  }, {
3897
3978
  preferenceToolbarAboveSelection?: boolean | undefined;
3898
3979
  }>>,
3899
- import("@atlaskit/editor-common/types").MaybePlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"annotation", {
3900
- pluginConfiguration: import("@atlaskit/editor-plugin-annotation").AnnotationProviders | undefined;
3901
- sharedState: import("@atlaskit/editor-plugin-annotation").InlineCommentPluginState | undefined;
3902
- dependencies: [
3903
- import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {
3904
- pluginConfiguration: import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions;
3905
- sharedState: {
3906
- createAnalyticsEvent: import("@atlaskit/analytics-next").CreateUIAnalyticsEvent | null;
3907
- attachAnalyticsEvent: import("@atlaskit/editor-plugin-analytics").CreateAttachPayloadIntoTransaction | null;
3908
- performanceTracking: import("@atlaskit/editor-common/types").PerformanceTracking | undefined;
3909
- };
3910
- dependencies: [
3911
- import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
3912
- pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
3913
- sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
3914
- }, import("@atlaskit/editor-common/types").FeatureFlags>>
3915
- ];
3916
- actions: import("@atlaskit/editor-common/analytics").EditorAnalyticsAPI;
3917
- }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>,
3918
- import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"editorViewMode", {
3919
- sharedState: import("@atlaskit/editor-plugin-editor-viewmode").EditorViewModePluginState | null;
3920
- dependencies: [
3921
- import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"collabEdit", {
3922
- pluginConfiguration: import("@atlaskit/editor-plugin-collab-edit").PrivateCollabEditOptions;
3923
- dependencies: [
3924
- import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
3925
- pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
3926
- sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
3927
- }, import("@atlaskit/editor-common/types").FeatureFlags>>,
3928
- import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {
3929
- pluginConfiguration: import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions;
3930
- sharedState: {
3931
- createAnalyticsEvent: import("@atlaskit/analytics-next").CreateUIAnalyticsEvent | null;
3932
- attachAnalyticsEvent: import("@atlaskit/editor-plugin-analytics").CreateAttachPayloadIntoTransaction | null;
3933
- performanceTracking: import("@atlaskit/editor-common/types").PerformanceTracking | undefined;
3934
- };
3935
- dependencies: [
3936
- import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
3937
- pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
3938
- sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
3939
- }, import("@atlaskit/editor-common/types").FeatureFlags>>
3940
- ];
3941
- actions: import("@atlaskit/editor-common/analytics").EditorAnalyticsAPI;
3942
- }, import("@atlaskit/editor-plugin-analytics").AnalyticsPluginOptions>>
3943
- ];
3944
- sharedState: import("@atlaskit/editor-plugin-collab-edit").CollabEditPluginSharedState;
3945
- actions: {
3946
- getAvatarColor: (str: string) => {
3947
- index: number;
3948
- color: import("@atlaskit/editor-common/collab").Color;
3949
- };
3950
- addInlineCommentMark: (props: {
3951
- from: number;
3952
- to: number;
3953
- mark: import("prosemirror-model").Mark;
3954
- }) => boolean;
3955
- };
3956
- }, import("@atlaskit/editor-plugin-collab-edit").PrivateCollabEditOptions>
3957
- ];
3958
- pluginConfiguration?: {
3959
- mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
3960
- } | undefined;
3961
- commands: {
3962
- updateViewMode: (mode: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode) => import("@atlaskit/editor-common/types").EditorCommand;
3963
- };
3964
- actions: {
3965
- applyViewModeStepAt: (tr: import("prosemirror-state").Transaction) => boolean;
3966
- };
3967
- }, {
3968
- mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
3969
- } | undefined>>,
3970
- import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
3971
- pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
3972
- sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
3973
- }, import("@atlaskit/editor-common/types").FeatureFlags>>
3974
- ];
3975
- actions: {
3976
- stripNonExistingAnnotations: (slice: import("prosemirror-model").Slice, state: import("prosemirror-state").EditorState) => boolean | undefined;
3977
- setInlineCommentDraftState: (drafting: boolean, inputMethod: import("@atlaskit/editor-plugin-annotation").InlineCommentInputMethod, targetType?: import("@atlaskit/editor-plugin-annotation").TargetType | undefined, isCommentOnMediaOn?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
3978
- };
3979
- }, import("@atlaskit/editor-plugin-annotation").AnnotationProviders | undefined>>,
3980
3980
  import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"clearMarksOnEmptyDoc", {}, undefined>,
3981
3981
  import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"blockType", {
3982
3982
  pluginConfiguration: import("@atlaskit/editor-plugin-block-type").BlockTypePluginOptions | undefined;
@@ -284,7 +284,7 @@ The full page examples in the storybook use the \`ExampleViewInlineCommentCompon
284
284
 
285
285
  ${code`
286
286
  import { Editor } from '@atlaskit/editor-core';
287
- import { ExampleViewInlineCommentComponent } from '@atlaskit/editor-core/examples-helpers/example-inline-comment-component';
287
+ import { ExampleViewInlineCommentComponent } from '@atlaskit/editor-test-helpers/example-helpers';
288
288
 
289
289
  class MyEditor extends React.Component {
290
290
  render() {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-core",
3
- "version": "192.7.0",
3
+ "version": "193.0.0",
4
4
  "description": "A package contains Atlassian editor core functionality",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -25,7 +25,6 @@
25
25
  "atlassian": {
26
26
  "team": "Editor",
27
27
  "singleton": true,
28
- "deprecatedAutoEntryPoints": true,
29
28
  "inPublicMirror": true,
30
29
  "releaseModel": "continuous",
31
30
  "website": {
@@ -45,7 +44,7 @@
45
44
  "@atlaskit/analytics-namespaced-context": "^6.9.0",
46
45
  "@atlaskit/analytics-next": "^9.2.0",
47
46
  "@atlaskit/analytics-next-stable-react-context": "1.0.1",
48
- "@atlaskit/button": "^17.6.0",
47
+ "@atlaskit/button": "^17.7.0",
49
48
  "@atlaskit/editor-common": "^78.11.0",
50
49
  "@atlaskit/editor-json-transformer": "^8.10.0",
51
50
  "@atlaskit/editor-plugins": "^1.5.0",
@@ -76,7 +75,7 @@
76
75
  "uuid": "^3.1.0"
77
76
  },
78
77
  "peerDependencies": {
79
- "@atlaskit/link-provider": "^1.6.2",
78
+ "@atlaskit/link-provider": "^1.8.0",
80
79
  "@atlaskit/media-core": "^34.2.0",
81
80
  "react": "^16.8.0",
82
81
  "react-dom": "^16.8.0",
@@ -88,16 +87,16 @@
88
87
  "@atlaskit/adf-utils": "^19.0.0",
89
88
  "@atlaskit/analytics-listeners": "^8.9.1",
90
89
  "@atlaskit/checkbox": "^13.0.0",
91
- "@atlaskit/collab-provider": "9.25.4",
90
+ "@atlaskit/collab-provider": "9.25.5",
92
91
  "@atlaskit/dropdown-menu": "^12.7.0",
93
- "@atlaskit/editor-plugin-annotation": "1.2.0",
92
+ "@atlaskit/editor-plugin-annotation": "1.2.1",
94
93
  "@atlaskit/editor-plugin-card": "^1.1.0",
95
94
  "@atlaskit/editor-plugin-editor-viewmode": "^1.0.0",
96
95
  "@atlaskit/editor-plugin-list": "^3.1.5",
97
96
  "@atlaskit/editor-plugin-paste": "^1.0.0",
98
97
  "@atlaskit/editor-test-helpers": "*",
99
98
  "@atlaskit/flag": "^15.2.0",
100
- "@atlaskit/link-provider": "^1.7.0",
99
+ "@atlaskit/link-provider": "^1.8.0",
101
100
  "@atlaskit/link-test-helpers": "^6.2.0",
102
101
  "@atlaskit/logo": "^13.15.0",
103
102
  "@atlaskit/media-core": "^34.2.0",
@@ -250,5 +249,19 @@
250
249
  "no-unused-dependencies": {
251
250
  "checkDevDependencies": true
252
251
  }
252
+ },
253
+ "af:exports": {
254
+ ".": "./src/index.ts",
255
+ "./composable-editor": "./src/composable-editor.ts",
256
+ "./editor-context": "./src/editor-context.ts",
257
+ "./editor": "./src/editor.tsx",
258
+ "./element-browser": "./src/element-browser.ts",
259
+ "./labs-next": "./src/labs-next.ts",
260
+ "./messages": "./src/messages.ts",
261
+ "./preset-default": "./src/preset-default.ts",
262
+ "./preset-universal": "./src/preset-universal.ts",
263
+ "./test-utils": "./src/test-utils.ts",
264
+ "./use-preset": "./src/use-preset.ts",
265
+ "./version-wrapper": "./src/version-wrapper.ts"
253
266
  }
254
- }
267
+ }
@@ -1,50 +0,0 @@
1
- import React from 'react';
2
-
3
- import SectionMessage from '@atlaskit/section-message';
4
-
5
- function AlternativePackagesMessage({
6
- alternatePackages,
7
- }: React.PropsWithoutRef<{
8
- alternatePackages?: { name: string; link: string }[];
9
- }>) {
10
- if (!alternatePackages) {
11
- return null;
12
- }
13
- if (alternatePackages.length === 1) {
14
- return (
15
- <p>
16
- Consider using{' '}
17
- <a href={alternatePackages[0].link}>{alternatePackages[0].name}</a>{' '}
18
- instead.
19
- </p>
20
- );
21
- }
22
- return (
23
- <p>
24
- Consider using one of these packages instead:
25
- <ul>
26
- {alternatePackages.map((p) => (
27
- <li>
28
- <a href={p.link}>{p.name}</a>
29
- </li>
30
- ))}
31
- </ul>
32
- </p>
33
- );
34
- }
35
-
36
- export function createEditorUseOnlyNotice(
37
- componentName: string,
38
- alternatePackages?: { name: string; link: string }[],
39
- ) {
40
- return (
41
- <SectionMessage title="Internal Editor Use Only" appearance="error">
42
- <p>
43
- {componentName} is intended for internal use by the Editor Platform as a
44
- plugin dependency of the Editor within your product.
45
- </p>
46
- <p>Direct use of this component is not supported.</p>
47
- <AlternativePackagesMessage alternatePackages={alternatePackages} />
48
- </SectionMessage>
49
- );
50
- }