@atlaskit/editor-core 187.11.0 → 187.12.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 (51) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/cjs/create-editor/ReactEditorViewInternal.js +1 -4
  3. package/dist/cjs/editor-next/editor-internal.js +0 -2
  4. package/dist/cjs/editor-next/hooks/useProviderFactory.js +2 -2
  5. package/dist/cjs/editor-next/index.js +0 -2
  6. package/dist/cjs/editor.js +6 -2
  7. package/dist/cjs/plugins/text-formatting/index.js +8 -14
  8. package/dist/cjs/{editor-next/utils/deprecationWarnings.js → utils/editorDeprecationWarnings.js} +3 -3
  9. package/dist/cjs/version-wrapper.js +1 -1
  10. package/dist/cjs/version.json +1 -1
  11. package/dist/es2019/create-editor/ReactEditorViewInternal.js +1 -4
  12. package/dist/es2019/editor-next/editor-internal.js +0 -2
  13. package/dist/es2019/editor-next/hooks/useProviderFactory.js +2 -2
  14. package/dist/es2019/editor-next/index.js +0 -2
  15. package/dist/es2019/editor.js +5 -0
  16. package/dist/es2019/plugins/text-formatting/index.js +115 -119
  17. package/dist/es2019/{editor-next/utils/deprecationWarnings.js → utils/editorDeprecationWarnings.js} +2 -2
  18. package/dist/es2019/version-wrapper.js +1 -1
  19. package/dist/es2019/version.json +1 -1
  20. package/dist/esm/create-editor/ReactEditorViewInternal.js +1 -4
  21. package/dist/esm/editor-next/editor-internal.js +0 -2
  22. package/dist/esm/editor-next/hooks/useProviderFactory.js +2 -2
  23. package/dist/esm/editor-next/index.js +0 -2
  24. package/dist/esm/editor.js +6 -2
  25. package/dist/esm/plugins/text-formatting/index.js +9 -15
  26. package/dist/esm/{editor-next/utils/deprecationWarnings.js → utils/editorDeprecationWarnings.js} +2 -2
  27. package/dist/esm/version-wrapper.js +1 -1
  28. package/dist/esm/version.json +1 -1
  29. package/dist/types/create-editor/ReactEditorViewInternal.d.ts +0 -1
  30. package/dist/types/editor-next/hooks/useProviderFactory.d.ts +4 -4
  31. package/dist/types/editor.d.ts +1 -0
  32. package/dist/types/labs/next/presets/default.d.ts +28 -56
  33. package/dist/types/labs/next/presets/useUniversalPreset.d.ts +2 -2
  34. package/dist/types/plugins/text-formatting/actions.d.ts +11 -9
  35. package/dist/types/plugins/text-formatting/index.d.ts +8 -15
  36. package/dist/types/types/editor-props.d.ts +10 -10
  37. package/dist/types/utils/editorDeprecationWarnings.d.ts +2 -0
  38. package/dist/types-ts4.5/create-editor/ReactEditorViewInternal.d.ts +0 -1
  39. package/dist/types-ts4.5/editor-next/hooks/useProviderFactory.d.ts +4 -4
  40. package/dist/types-ts4.5/editor.d.ts +1 -0
  41. package/dist/types-ts4.5/labs/next/presets/default.d.ts +28 -56
  42. package/dist/types-ts4.5/labs/next/presets/useUniversalPreset.d.ts +2 -2
  43. package/dist/types-ts4.5/plugins/text-formatting/actions.d.ts +11 -9
  44. package/dist/types-ts4.5/plugins/text-formatting/index.d.ts +8 -15
  45. package/dist/types-ts4.5/types/editor-props.d.ts +10 -10
  46. package/dist/types-ts4.5/utils/editorDeprecationWarnings.d.ts +2 -0
  47. package/package.json +2 -2
  48. package/report.api.md +25 -38
  49. package/tmp/api-report-tmp.d.ts +25 -36
  50. package/dist/types/editor-next/utils/deprecationWarnings.d.ts +0 -2
  51. package/dist/types-ts4.5/editor-next/utils/deprecationWarnings.d.ts +0 -2
@@ -64,7 +64,6 @@ interface EditorBaseProps {
64
64
  contextPanel?: ReactComponents;
65
65
  errorReporterHandler?: ErrorReportingHandler;
66
66
  contentTransformerProvider?: (schema: Schema) => Transformer<string>;
67
- textFormatting?: TextFormattingOptions;
68
67
  maxHeight?: number;
69
68
  minHeight?: number;
70
69
  placeholder?: string;
@@ -87,7 +86,6 @@ interface EditorBaseProps {
87
86
  inputSamplingLimit?: number;
88
87
  extensionProviders?: ExtensionProvidersProp;
89
88
  UNSAFE_useAnalyticsContext?: boolean;
90
- codeBlock?: CodeBlockOptions;
91
89
  /**
92
90
  * @default undefined
93
91
  * @description Enables valid transaction events to be tracked in analytics (at a sampled rate)
@@ -144,22 +142,16 @@ export interface EditorSharedPropsWithPlugins {
144
142
  */
145
143
  performanceTracking?: PerformanceTracking;
146
144
  sanitizePrivateContent?: boolean;
147
- allowAnalyticsGASV3?: boolean;
148
145
  media?: MediaOptions;
149
146
  collabEdit?: CollabEditOptions;
150
- insertMenuItems?: MenuItem[];
147
+ codeBlock?: CodeBlockOptions;
148
+ textFormatting?: TextFormattingOptions;
151
149
  primaryToolbarComponents?: PrimaryToolbarComponents;
152
150
  allowUndoRedoButtons?: boolean;
153
- allowTables?: boolean | TablesPluginConfig;
154
- /** @deprecated Use smartLinks instead. */
155
- UNSAFE_cards?: CardOptions;
156
- /** @deprecated Use linking instead. */
157
- smartLinks?: CardOptions;
158
151
  /**
159
152
  * Configure and extend editor linking behaviour
160
153
  */
161
154
  linking?: LinkingOptions;
162
- contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
163
155
  }
164
156
  export interface EditorProps extends EditorBaseProps, EditorPluginFeatureProps, EditorSharedPropsWithPlugins, EditorProviderProps {
165
157
  /**
@@ -188,6 +180,7 @@ export interface EditorProviderProps {
188
180
  mentionProvider?: Promise<MentionProvider>;
189
181
  autoformattingProvider?: Providers['autoformattingProvider'];
190
182
  macroProvider?: Providers['macroProvider'];
183
+ contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
191
184
  }
192
185
  export interface EditorPluginFeatureProps {
193
186
  allowExpand?: boolean | {
@@ -253,4 +246,11 @@ export interface EditorPluginFeatureProps {
253
246
  waitForMediaUpload?: boolean;
254
247
  extensionHandlers?: ExtensionHandlers;
255
248
  allowTextColor?: boolean | TextColorPluginConfig;
249
+ allowTables?: boolean | TablesPluginConfig;
250
+ insertMenuItems?: MenuItem[];
251
+ /** @deprecated Use smartLinks instead. */
252
+ UNSAFE_cards?: CardOptions;
253
+ /** @deprecated Use linking instead. */
254
+ smartLinks?: CardOptions;
255
+ allowAnalyticsGASV3?: boolean;
256
256
  }
@@ -0,0 +1,2 @@
1
+ import type { EditorProps } from '../types/editor-props';
2
+ export default function editorDeprecationWarnings(props: EditorProps): void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-core",
3
- "version": "187.11.0",
3
+ "version": "187.12.0",
4
4
  "description": "A package contains Atlassian editor core functionality",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -140,7 +140,7 @@
140
140
  "@af/editor-libra": "*",
141
141
  "@af/integration-testing": "*",
142
142
  "@atlaskit/code": "^14.6.0",
143
- "@atlaskit/collab-provider": "9.7.4",
143
+ "@atlaskit/collab-provider": "9.8.0",
144
144
  "@atlaskit/dropdown-menu": "^11.11.0",
145
145
  "@atlaskit/editor-extension-dropbox": "^0.4.0",
146
146
  "@atlaskit/editor-plugin-table": "^2.6.0",
package/report.api.md CHANGED
@@ -582,6 +582,7 @@ export { DropdownOptionT };
582
582
 
583
583
  // @public (undocumented)
584
584
  export class Editor extends React_2.Component<EditorProps> {
585
+ constructor(props: EditorProps);
585
586
  // (undocumented)
586
587
  static defaultProps: EditorProps;
587
588
  // (undocumented)
@@ -655,8 +656,6 @@ interface EditorBaseProps {
655
656
  // (undocumented)
656
657
  assistiveLabel?: string;
657
658
  // (undocumented)
658
- codeBlock?: CodeBlockOptions;
659
- // (undocumented)
660
659
  contentComponents?: ReactComponents;
661
660
  // (undocumented)
662
661
  contentTransformerProvider?: (schema: Schema) => Transformer_2<string>;
@@ -709,8 +708,6 @@ interface EditorBaseProps {
709
708
  secondaryToolbarComponents?: ReactComponents;
710
709
  // (undocumented)
711
710
  shouldFocus?: boolean;
712
- // (undocumented)
713
- textFormatting?: TextFormattingOptions;
714
711
  trackValidTransactions?:
715
712
  | boolean
716
713
  | {
@@ -810,6 +807,8 @@ export { EditorPlugin };
810
807
 
811
808
  // @public (undocumented)
812
809
  interface EditorPluginFeatureProps {
810
+ // (undocumented)
811
+ allowAnalyticsGASV3?: boolean;
813
812
  // (undocumented)
814
813
  allowBlockType?: BlockTypePluginOptions['allowBlockType'];
815
814
  // (undocumented)
@@ -852,6 +851,8 @@ interface EditorPluginFeatureProps {
852
851
  menuDisabled: boolean;
853
852
  };
854
853
  // (undocumented)
854
+ allowTables?: PluginConfig | boolean;
855
+ // (undocumented)
855
856
  allowTasksAndDecisions?: boolean;
856
857
  // (undocumented)
857
858
  allowTemplatePlaceholders?: PlaceholderTextOptions | boolean;
@@ -872,6 +873,8 @@ interface EditorPluginFeatureProps {
872
873
  // (undocumented)
873
874
  feedbackInfo?: FeedbackInfo;
874
875
  // (undocumented)
876
+ insertMenuItems?: MenuItem[];
877
+ // (undocumented)
875
878
  maxContentSize?: number;
876
879
  // (undocumented)
877
880
  mention?: MentionPluginConfig;
@@ -879,7 +882,11 @@ interface EditorPluginFeatureProps {
879
882
  mentionInsertDisplayName?: boolean;
880
883
  // (undocumented)
881
884
  saveOnEnter?: boolean;
885
+ // @deprecated (undocumented)
886
+ smartLinks?: CardOptions;
882
887
  UNSAFE_allowBorderMark?: boolean;
888
+ // @deprecated (undocumented)
889
+ UNSAFE_cards?: CardOptions;
883
890
  // (undocumented)
884
891
  uploadErrorHandler?: (state: MediaState) => void;
885
892
  // (undocumented)
@@ -922,6 +929,8 @@ interface EditorProviderProps {
922
929
  // (undocumented)
923
930
  collabEditProvider?: Providers['collabEditProvider'];
924
931
  // (undocumented)
932
+ contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
933
+ // (undocumented)
925
934
  emojiProvider?: Providers['emojiProvider'];
926
935
  // (undocumented)
927
936
  legacyImageUploadProvider?: Providers['imageUploadProvider'];
@@ -939,18 +948,12 @@ interface EditorProviderProps {
939
948
 
940
949
  // @public (undocumented)
941
950
  interface EditorSharedPropsWithPlugins {
942
- // (undocumented)
943
- allowAnalyticsGASV3?: boolean;
944
- // (undocumented)
945
- allowTables?: PluginConfig | boolean;
946
951
  // (undocumented)
947
952
  allowUndoRedoButtons?: boolean;
948
953
  // (undocumented)
949
- collabEdit?: CollabEditOptions;
950
- // (undocumented)
951
- contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
954
+ codeBlock?: CodeBlockOptions;
952
955
  // (undocumented)
953
- insertMenuItems?: MenuItem[];
956
+ collabEdit?: CollabEditOptions;
954
957
  linking?: LinkingOptions;
955
958
  // (undocumented)
956
959
  media?: MediaOptions;
@@ -961,16 +964,12 @@ interface EditorSharedPropsWithPlugins {
961
964
  primaryToolbarComponents?: PrimaryToolbarComponents;
962
965
  // (undocumented)
963
966
  sanitizePrivateContent?: boolean;
964
- // @deprecated (undocumented)
965
- smartLinks?: CardOptions;
966
- // @deprecated (undocumented)
967
- UNSAFE_cards?: CardOptions;
967
+ // (undocumented)
968
+ textFormatting?: TextFormattingOptions;
968
969
  }
969
970
 
970
971
  // @public (undocumented)
971
972
  interface EditorViewProps {
972
- // (undocumented)
973
- allowAnalyticsGASV3?: boolean;
974
973
  // (undocumented)
975
974
  createAnalyticsEvent?: CreateUIAnalyticsEvent;
976
975
  // (undocumented)
@@ -2175,20 +2174,13 @@ export const textFormattingPlugin: NextEditorPlugin<
2175
2174
  pluginConfiguration: TextFormattingOptions | undefined;
2176
2175
  dependencies: [OptionalPlugin<typeof analyticsPlugin>];
2177
2176
  actions: {
2178
- toggleSuperscript: ToggleMarkCommand;
2179
- toggleSuperscriptWithAnalytics: ToggleMarkWithAnalyticsCommand;
2180
- toggleSubscript: ToggleMarkCommand;
2181
- toggleSubscriptWithAnalytics: ToggleMarkWithAnalyticsCommand;
2182
- toggleStrike: ToggleMarkCommand;
2183
- toggleStrikeWithAnalytics: ToggleMarkWithAnalyticsCommand;
2184
- toggleCode: ToggleMarkCommand;
2185
- toggleCodeWithAnalytics: ToggleMarkWithAnalyticsCommand;
2186
- toggleUnderline: ToggleMarkCommand;
2187
- toggleUnderlineWithAnalytics: ToggleMarkWithAnalyticsCommand;
2188
- toggleEm: ToggleMarkCommand;
2189
- toggleEmWithAnalytics: ToggleMarkWithAnalyticsCommand;
2190
- toggleStrong: ToggleMarkCommand;
2191
- toggleStrongWithAnalytics: ToggleMarkWithAnalyticsCommand;
2177
+ toggleSuperscript: ToggleMarkWithAnalyticsCommand;
2178
+ toggleSubscript: ToggleMarkWithAnalyticsCommand;
2179
+ toggleStrike: ToggleMarkWithAnalyticsCommand;
2180
+ toggleCode: ToggleMarkWithAnalyticsCommand;
2181
+ toggleUnderline: ToggleMarkWithAnalyticsCommand;
2182
+ toggleEm: ToggleMarkWithAnalyticsCommand;
2183
+ toggleStrong: ToggleMarkWithAnalyticsCommand;
2192
2184
  };
2193
2185
  }
2194
2186
  >;
@@ -2204,12 +2196,7 @@ interface TextSelectionData {
2204
2196
  }
2205
2197
 
2206
2198
  // @public (undocumented)
2207
- type ToggleMarkCommand = () => Command_2;
2208
-
2209
- // @public (undocumented)
2210
- type ToggleMarkWithAnalyticsCommand = (
2211
- editorAnalyticsAPI: EditorAnalyticsAPI | undefined,
2212
- ) => (analyticsMetadata: {
2199
+ type ToggleMarkWithAnalyticsCommand = (analyticsMetadata: {
2213
2200
  inputMethod: TextFormattingInputMethodBasic;
2214
2201
  }) => Command_2;
2215
2202
 
@@ -536,6 +536,7 @@ export { DropdownOptionT }
536
536
 
537
537
  // @public (undocumented)
538
538
  export class Editor extends React_2.Component<EditorProps> {
539
+ constructor(props: EditorProps);
539
540
  // (undocumented)
540
541
  static defaultProps: EditorProps;
541
542
  // (undocumented)
@@ -594,8 +595,6 @@ interface EditorBaseProps {
594
595
  // (undocumented)
595
596
  assistiveLabel?: string;
596
597
  // (undocumented)
597
- codeBlock?: CodeBlockOptions;
598
- // (undocumented)
599
598
  contentComponents?: ReactComponents;
600
599
  // (undocumented)
601
600
  contentTransformerProvider?: (schema: Schema) => Transformer_2<string>;
@@ -648,8 +647,6 @@ interface EditorBaseProps {
648
647
  secondaryToolbarComponents?: ReactComponents;
649
648
  // (undocumented)
650
649
  shouldFocus?: boolean;
651
- // (undocumented)
652
- textFormatting?: TextFormattingOptions;
653
650
  trackValidTransactions?: boolean | {
654
651
  samplingRate: number;
655
652
  };
@@ -741,6 +738,8 @@ export { EditorPlugin }
741
738
 
742
739
  // @public (undocumented)
743
740
  interface EditorPluginFeatureProps {
741
+ // (undocumented)
742
+ allowAnalyticsGASV3?: boolean;
744
743
  // (undocumented)
745
744
  allowBlockType?: BlockTypePluginOptions['allowBlockType'];
746
745
  // (undocumented)
@@ -779,6 +778,8 @@ interface EditorPluginFeatureProps {
779
778
  menuDisabled: boolean;
780
779
  };
781
780
  // (undocumented)
781
+ allowTables?: PluginConfig | boolean;
782
+ // (undocumented)
782
783
  allowTasksAndDecisions?: boolean;
783
784
  // (undocumented)
784
785
  allowTemplatePlaceholders?: PlaceholderTextOptions | boolean;
@@ -799,6 +800,8 @@ interface EditorPluginFeatureProps {
799
800
  // (undocumented)
800
801
  feedbackInfo?: FeedbackInfo;
801
802
  // (undocumented)
803
+ insertMenuItems?: MenuItem[];
804
+ // (undocumented)
802
805
  maxContentSize?: number;
803
806
  // (undocumented)
804
807
  mention?: MentionPluginConfig;
@@ -806,7 +809,11 @@ interface EditorPluginFeatureProps {
806
809
  mentionInsertDisplayName?: boolean;
807
810
  // (undocumented)
808
811
  saveOnEnter?: boolean;
812
+ // @deprecated (undocumented)
813
+ smartLinks?: CardOptions;
809
814
  UNSAFE_allowBorderMark?: boolean;
815
+ // @deprecated (undocumented)
816
+ UNSAFE_cards?: CardOptions;
810
817
  // (undocumented)
811
818
  uploadErrorHandler?: (state: MediaState) => void;
812
819
  // (undocumented)
@@ -845,6 +852,8 @@ interface EditorProviderProps {
845
852
  // (undocumented)
846
853
  collabEditProvider?: Providers['collabEditProvider'];
847
854
  // (undocumented)
855
+ contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
856
+ // (undocumented)
848
857
  emojiProvider?: Providers['emojiProvider'];
849
858
  // (undocumented)
850
859
  legacyImageUploadProvider?: Providers['imageUploadProvider'];
@@ -862,18 +871,12 @@ interface EditorProviderProps {
862
871
 
863
872
  // @public (undocumented)
864
873
  interface EditorSharedPropsWithPlugins {
865
- // (undocumented)
866
- allowAnalyticsGASV3?: boolean;
867
- // (undocumented)
868
- allowTables?: PluginConfig | boolean;
869
874
  // (undocumented)
870
875
  allowUndoRedoButtons?: boolean;
871
876
  // (undocumented)
872
- collabEdit?: CollabEditOptions;
873
- // (undocumented)
874
- contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
877
+ codeBlock?: CodeBlockOptions;
875
878
  // (undocumented)
876
- insertMenuItems?: MenuItem[];
879
+ collabEdit?: CollabEditOptions;
877
880
  linking?: LinkingOptions;
878
881
  // (undocumented)
879
882
  media?: MediaOptions;
@@ -884,16 +887,12 @@ interface EditorSharedPropsWithPlugins {
884
887
  primaryToolbarComponents?: PrimaryToolbarComponents;
885
888
  // (undocumented)
886
889
  sanitizePrivateContent?: boolean;
887
- // @deprecated (undocumented)
888
- smartLinks?: CardOptions;
889
- // @deprecated (undocumented)
890
- UNSAFE_cards?: CardOptions;
890
+ // (undocumented)
891
+ textFormatting?: TextFormattingOptions;
891
892
  }
892
893
 
893
894
  // @public (undocumented)
894
895
  interface EditorViewProps {
895
- // (undocumented)
896
- allowAnalyticsGASV3?: boolean;
897
896
  // (undocumented)
898
897
  createAnalyticsEvent?: CreateUIAnalyticsEvent;
899
898
  // (undocumented)
@@ -1939,20 +1938,13 @@ export const textFormattingPlugin: NextEditorPlugin<'textFormatting', {
1939
1938
  pluginConfiguration: TextFormattingOptions | undefined;
1940
1939
  dependencies: [OptionalPlugin<typeof analyticsPlugin>];
1941
1940
  actions: {
1942
- toggleSuperscript: ToggleMarkCommand;
1943
- toggleSuperscriptWithAnalytics: ToggleMarkWithAnalyticsCommand;
1944
- toggleSubscript: ToggleMarkCommand;
1945
- toggleSubscriptWithAnalytics: ToggleMarkWithAnalyticsCommand;
1946
- toggleStrike: ToggleMarkCommand;
1947
- toggleStrikeWithAnalytics: ToggleMarkWithAnalyticsCommand;
1948
- toggleCode: ToggleMarkCommand;
1949
- toggleCodeWithAnalytics: ToggleMarkWithAnalyticsCommand;
1950
- toggleUnderline: ToggleMarkCommand;
1951
- toggleUnderlineWithAnalytics: ToggleMarkWithAnalyticsCommand;
1952
- toggleEm: ToggleMarkCommand;
1953
- toggleEmWithAnalytics: ToggleMarkWithAnalyticsCommand;
1954
- toggleStrong: ToggleMarkCommand;
1955
- toggleStrongWithAnalytics: ToggleMarkWithAnalyticsCommand;
1941
+ toggleSuperscript: ToggleMarkWithAnalyticsCommand;
1942
+ toggleSubscript: ToggleMarkWithAnalyticsCommand;
1943
+ toggleStrike: ToggleMarkWithAnalyticsCommand;
1944
+ toggleCode: ToggleMarkWithAnalyticsCommand;
1945
+ toggleUnderline: ToggleMarkWithAnalyticsCommand;
1946
+ toggleEm: ToggleMarkWithAnalyticsCommand;
1947
+ toggleStrong: ToggleMarkWithAnalyticsCommand;
1956
1948
  };
1957
1949
  }>;
1958
1950
 
@@ -1967,10 +1959,7 @@ interface TextSelectionData {
1967
1959
  }
1968
1960
 
1969
1961
  // @public (undocumented)
1970
- type ToggleMarkCommand = () => Command_2;
1971
-
1972
- // @public (undocumented)
1973
- type ToggleMarkWithAnalyticsCommand = (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (analyticsMetadata: {
1962
+ type ToggleMarkWithAnalyticsCommand = (analyticsMetadata: {
1974
1963
  inputMethod: TextFormattingInputMethodBasic;
1975
1964
  }) => Command_2;
1976
1965
 
@@ -1,2 +0,0 @@
1
- import { EditorNextProps, EditorProps } from '../../types/editor-props';
2
- export default function deprecationWarnings(props: EditorProps | EditorNextProps): void;
@@ -1,2 +0,0 @@
1
- import { EditorNextProps, EditorProps } from '../../types/editor-props';
2
- export default function deprecationWarnings(props: EditorProps | EditorNextProps): void;