@atlaskit/editor-core 191.3.1 → 191.4.0

package/dist/types-ts4.5/utils/performance/plugin-performance-observer.d.ts

@@ -1,5 +1,5 @@
-import { NodesCount, PluginPerformanceReportData, PluginPerformanceReportOptions } from './plugin-performance-report';
-import { TransactionTracker } from './track-transactions';
+import type { NodesCount, PluginPerformanceReportData, PluginPerformanceReportOptions } from './plugin-performance-report';
+import type { TransactionTracker } from './track-transactions';
 export declare class PluginPerformanceObserver implements PerformanceObserver {
     private callback;
     private getNodeCounts;

package/dist/types-ts4.5/utils/performance/plugin-performance-report.d.ts

@@ -1,4 +1,4 @@
-import { PluginMethodReport, PluginsReport, NodeCount, PluginPerformanceReportData } from '@atlaskit/editor-common/analytics';
+import type { NodeCount, PluginMethodReport, PluginPerformanceReportData, PluginsReport } from '@atlaskit/editor-common/analytics';
 export type { PluginMethodReport, PluginsReport, NodeCount, PluginPerformanceReportData, };
 export interface OutlierReport {
     stateApplyOutlier: number | undefined;

package/dist/types-ts4.5/utils/prepare-quick-insert-provider.d.ts

@@ -1,8 +1,8 @@
-import type { ExtensionProvider } from '@atlaskit/editor-common/extensions';
 import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
+import type { ExtensionProvider } from '@atlaskit/editor-common/extensions';
 import type { QuickInsertProvider } from '@atlaskit/editor-common/provider-factory';
-import type EditorActions from '../actions';
 import type { QuickInsertOptions } from '@atlaskit/editor-common/types';
+import type EditorActions from '../actions';
 /**
  *
  * Used to combine the quickInsert provider and extension provider (if available)

package/docs/0-intro.tsx

@@ -1,10 +1,11 @@
 import React from 'react';
+
 import {
-  md,
+  AtlassianInternalWarning,
   code,
   Example,
+  md,
   Props,
-  AtlassianInternalWarning,
 } from '@atlaskit/docs';
 
 export default md`
@@ -54,32 +55,10 @@ import { usePreset } from '@atlaskit/editor-core/use-preset';
 import { basePlugin } from '@atlaskit/editor-plugin-base';
 
 const CommentEditor = () => {
-  const { preset } = usePreset(() => 
-    new EditorPresetBuilder().add(basePlugin)
-  , []);
+  const { preset } = usePreset(() => new EditorPresetBuilder().add(basePlugin));
 
   return <ComposableEditor preset={preset} />;
 };
-`}
-
-  You can enable more editor functionality by passing extra plugins to the preset as discussed below.
-
-  If coming from the legacy editor, the simplest migration would be via the \`universal\` preset.
-
-  **Warning**: The \`universal\` preset brings in all editor plugins which can impact heavily bundle size. It is generally recommended to build your own custom preset as will be discussed.
-
-  ${code`
-import { ComposableEditor } from '@atlaskit/editor-core/composable-editor';
-import { useUniversalPreset } from '@atlaskit/editor-core/preset-universal';
-
-const CommentEditor = () => {
-  const presetProps = {
-    props: {},
-  };
-  const universalPreset = useUniversalPreset(presetProps);
-
-  return <ComposableEditor preset={universalPreset} />;
-};
 `}
 
   ## Configuration
@@ -98,7 +77,7 @@ import { usePreset } from '@atlaskit/editor-core/use-preset';
 
 const createPreset = () =>
   createDefaultPreset({ featureFlags: {}, paste: {} });
-const { preset } = usePreset(createPreset, []);
+const { preset } = usePreset(createPreset);
 `}
 
   The default preset encompasses all the essentials needed for the Editor to function, representing the minimum set of plugins. It includes core Atlassian libraries essential for editor development \(feature flags, analytics, editor state management\), as well as common editor features \(copy/paste, clipboard support, focus, composition, decorations, undo/redo, block elements, annotations, hyperlink support, basic text formatting, responsive width support, quick-insert, type-ahead, placeholder text, editor controls, selections, code blocks\). Some of these core plugins can be disabled through the configuration object passed into \`createDefaultPreset\`.
@@ -117,6 +96,7 @@ const universalPreset = useUniversalPreset(presetProps);
 
   In addition to the default preset, the universal preset contains a comprehensive set of features for a fully-featured editor. It supports functionalities like data consumers, content insertion, breakout, alignment, text color, lists, rules, expands, guidelines, media, captions, mentions, emoji, tables, tasks & decisions, feedback dialogs, help dialogs, collaborative editing, maximum content size restrictions, Jira issue linking, panels, context panels, extensions, macros, annotations, dates, placeholder text, layouts, cards, auto-formatting rules, status elements, indentation, scroll-into-view behavior, complex history behavior, mobile support, and advanced toolbar support.
 
+  Warning: The universal preset includes all editor plugins, which can significantly increase bundle size. It is generally advisable to create a custom preset according to your needs.
 
   #### Adding a plugin to a preset
 
@@ -132,14 +112,14 @@ import { usePreset } from '@atlaskit/editor-core/use-preset';
 const createPreset = () =>
   createDefaultPreset({ featureFlags: {}, paste: {} })
     .add(listPlugin)
-    .maybeAdd(NextEditorPluginAI, (plugin, builder) => {
-      if (editorPluginAIProvider) {
-        return builder.add([plugin, { editorPluginAIProvider }]); // Add the plugin
+    .maybeAdd(historyPlugin, (plugin, builder) => {
+      if (featureFlag) {
+        return builder.add(plugin); // Add the plugin
       }
       return builder; // Don't add the plugin
     });
     
-const { preset } = usePreset(createPreset, []);
+const { preset } = usePreset(createPreset);
 `}
 
   Some plugins are dependent on others. If you encounter type issues with a specific plugin, it's crucial to verify that all necessary dependencies have been added. These can be cross-checked within the individual documentation of each plugin.
@@ -158,7 +138,7 @@ const createPreset = () =>
     .add([cardPlugin, { platform: 'web' }])
     .add(listPlugin);
 
-const { preset } = usePreset(createPreset, []);
+const { preset } = usePreset(createPreset);
 `}
 
   Or from scratch (simple preset with basic text formatting, list, analytics, and headings):
@@ -179,7 +159,7 @@ const createPreset = () =>
       .add(blockTypePlugin)
       .add(listPlugin)
 
-const { preset } = usePreset(createPreset, []);
+const { preset } = usePreset(createPreset);
 `}
 
   To keep your integrated editor running smoothly, it's important to have a stable preset. If you generate a new preset every time the editor re-renders, it can slow things down significantly. The best way to maintain a stable preset across re-renders is to use the \`usePreset\` hook or similar memoization techniques. This helps your editor run efficiently without unnecessary recalculations.
@@ -199,7 +179,7 @@ ${code`
 
   const createPreset = () =>
     createDefaultPreset({ featureFlags: {}, paste: {} });
-  const { preset } = usePreset(createPreset, []);
+  const { preset } = usePreset(createPreset);
 
   // 'comment' is the default appearance, you don't need to pass it
   return <ComposableEditor appearance='comment' preset={preset} />;
@@ -211,7 +191,7 @@ ${code`
 
   const createPreset = () =>
     createDefaultPreset({ featureFlags: {}, paste: {} });
-  const { preset } = usePreset(createPreset, []);
+  const { preset } = usePreset(createPreset);
 
   return <ComposableEditor preset={preset} />;
 `}
@@ -224,7 +204,7 @@ ${code`
 ${code`
   const createPreset = () =>
     createDefaultPreset({ featureFlags: {}, paste: {} });
-  const { preset } = usePreset(createPreset, []);
+  const { preset } = usePreset(createPreset);
   
   return <ComposableEditor appearance='full-page' preset={preset} />;
   // Or full-width
@@ -239,7 +219,7 @@ ${code`
 ${code`
   const createPreset = () =>
     createDefaultPreset({ featureFlags: {}, paste: {} });
-  const { preset } = usePreset(createPreset, []);
+  const { preset } = usePreset(createPreset);
   return <ComposableEditor appearance='chromeless' preset={preset} />;
 `}
 
@@ -250,7 +230,7 @@ ${code`
 ${code`
   const createPreset = () =>
     createDefaultPreset({ featureFlags: {}, paste: {} });
-  const { preset } = usePreset(createPreset, []);
+  const { preset } = usePreset(createPreset);
   return <ComposableEditor appearance='mobile' preset={preset} />;
 `}
 
@@ -272,7 +252,7 @@ const CollapsibleEditor = () => {
 
   const createPreset = () =>
     createDefaultPreset({ featureFlags: {}, paste: {} });
-  const { preset } = usePreset(createPreset, []);
+  const { preset } = usePreset(createPreset);
 
   return (
     <CollapsedEditor
@@ -281,7 +261,6 @@ const CollapsibleEditor = () => {
       isExpanded={isExpanded}>
       <ComposableEditor
         preset={preset}
-        // TODO: We don't actually want people to use onSave
         onSave={(_editorView) => alert('The save button is a lie.')}
         onCancel={() => setIsExpanded(false)}
       />
@@ -320,7 +299,7 @@ const CommentEditorWithMentions = () => {
 
   const createPreset = () =>
     createDefaultPreset({ featureFlags: {}, paste: {} });
-  const { preset } = usePreset(createPreset, []);
+  const { preset } = usePreset(createPreset);
 
   return <ComposableEditor preset={preset} mentionProvider={presetProps.props.mentionProvider} />;
 };

package/docs/1-legacy-editor.tsx

@@ -1,10 +1,11 @@
 import React from 'react';
+
 import {
-  md,
+  AtlassianInternalWarning,
   code,
   Example,
+  md,
   Props,
-  AtlassianInternalWarning,
 } from '@atlaskit/docs';
 
 export default md`

package/docs/2-labs.tsx

@@ -1,4 +1,4 @@
-import { md, code } from '@atlaskit/docs';
+import { code, md } from '@atlaskit/docs';
 
 export default md`
   # Editor Labs

package/docs/3-autoformatting.tsx

@@ -1,4 +1,4 @@
-import { md, code } from '@atlaskit/docs';
+import { code, md } from '@atlaskit/docs';
 
 export default md`
 # Autoformatting Provider

package/docs/4-annotations.tsx

@@ -1,10 +1,10 @@
-import { token } from '@atlaskit/tokens';
 /* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import React from 'react';
 
 import { code, md } from '@atlaskit/docs';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { N20, N30 } from '@atlaskit/theme/colors';
+import { token } from '@atlaskit/tokens';
 
 import { Editor } from '../src';
 

package/docs/editor-use-only.tsx

@@ -1,4 +1,5 @@
 import React from 'react';
+
 import SectionMessage from '@atlaskit/section-message';
 
 function AlternativePackagesMessage({

package/editor-context/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/editor-core/editor-context",
+  "main": "../dist/cjs/editor-context.js",
+  "module": "../dist/esm/editor-context.js",
+  "module:es2019": "../dist/es2019/editor-context.js",
+  "sideEffects": false,
+  "types": "../dist/types/editor-context.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "../dist/types-ts4.5/editor-context.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-core",
-  "version": "191.3.1",
+  "version": "191.4.0",
   "description": "A package contains Atlassian editor core functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -46,7 +46,7 @@
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/analytics-next-stable-react-context": "1.0.1",
     "@atlaskit/button": "^17.2.0",
-    "@atlaskit/editor-common": "^76.40.0",
+    "@atlaskit/editor-common": "^76.41.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-plugin-alignment": "^0.1.0",
     "@atlaskit/editor-plugin-analytics": "^0.4.0",
@@ -76,7 +76,7 @@
     "@atlaskit/editor-plugin-editor-disabled": "^0.2.0",
     "@atlaskit/editor-plugin-emoji": "^1.0.0",
     "@atlaskit/editor-plugin-expand": "^0.4.0",
-    "@atlaskit/editor-plugin-extension": "^0.5.0",
+    "@atlaskit/editor-plugin-extension": "^0.6.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
     "@atlaskit/editor-plugin-feedback-dialog": "^0.1.0",
     "@atlaskit/editor-plugin-find-replace": "^0.1.0",
@@ -110,7 +110,7 @@
     "@atlaskit/editor-plugin-selection-toolbar": "^0.1.0",
     "@atlaskit/editor-plugin-status": "^0.2.0",
     "@atlaskit/editor-plugin-submit-editor": "^0.1.0",
-    "@atlaskit/editor-plugin-table": "^6.0.0",
+    "@atlaskit/editor-plugin-table": "^6.1.0",
     "@atlaskit/editor-plugin-tasks-and-decisions": "^0.2.0",
     "@atlaskit/editor-plugin-text-color": "^0.1.0",
     "@atlaskit/editor-plugin-text-formatting": "^0.4.0",
@@ -129,7 +129,7 @@
     "@atlaskit/spinner": "^16.0.0",
     "@atlaskit/task-decision": "^17.9.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.33.0",
+    "@atlaskit/tokens": "^1.34.0",
     "@atlaskit/tooltip": "^18.1.0",
     "@atlaskit/ufo": "^0.2.0",
     "@atlaskit/width-detector": "^4.1.0",
@@ -217,6 +217,9 @@
   },
   "techstack": {
     "@atlassian/frontend": {
+      "import-structure": [
+        "atlassian-conventions"
+      ],
       "circular-dependencies": [
         "file-level"
       ]