@atlaskit/editor-core 204.7.2 → 204.8.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-core
 
+## 204.8.0
+
+### Minor Changes
+
+- [#126109](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/126109)
+  [`b8eb107432364`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b8eb107432364) -
+  marked EditorActions as deprecated
+
+### Patch Changes
+
+- [#130624](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/130624)
+  [`8f52e4f05f49b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8f52e4f05f49b) -
+  updated docs to reflect our upgrade of editor-core to React 18
+- Updated dependencies
+
 ## 204.7.2
 
 ### Patch Changes

package/dist/cjs/actions/index.js

@@ -33,6 +33,14 @@ var fakePluginKey = {
   }
 };
 
+/**
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-26729 Internal documentation for deprecation (no external access)} Editor actions is no longer supported and will be removed in a future version. Please use the core actions, or Plugin APIs directly instead
+ * @example If you were using editorActions.getValue() replace with:
+	const { editorApi, preset } = usePreset(...);
+	editorApi?.core.actions.requestDocument((doc) => {
+  		// use doc as desired
+	})
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 var EditorActions = exports.default = /*#__PURE__*/function () {
   function EditorActions() {

package/dist/cjs/version-wrapper.js

@@ -5,4 +5,4 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.name = void 0;
 var name = exports.name = "@atlaskit/editor-core";
-var version = exports.version = "204.7.2";
+var version = exports.version = "204.8.0";

package/dist/es2019/actions/index.js

@@ -23,6 +23,14 @@ const fakePluginKey = {
   }
 };
 
+/**
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-26729 Internal documentation for deprecation (no external access)} Editor actions is no longer supported and will be removed in a future version. Please use the core actions, or Plugin APIs directly instead
+ * @example If you were using editorActions.getValue() replace with:
+	const { editorApi, preset } = usePreset(...);
+	editorApi?.core.actions.requestDocument((doc) => {
+  		// use doc as desired
+	})
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export default class EditorActions {
   constructor() {

package/dist/es2019/version-wrapper.js

@@ -1,2 +1,2 @@
 export const name = "@atlaskit/editor-core";
-export const version = "204.7.2";
+export const version = "204.8.0";

package/dist/esm/actions/index.js

@@ -27,6 +27,14 @@ var fakePluginKey = {
   }
 };
 
+/**
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-26729 Internal documentation for deprecation (no external access)} Editor actions is no longer supported and will be removed in a future version. Please use the core actions, or Plugin APIs directly instead
+ * @example If you were using editorActions.getValue() replace with:
+	const { editorApi, preset } = usePreset(...);
+	editorApi?.core.actions.requestDocument((doc) => {
+  		// use doc as desired
+	})
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 var EditorActions = /*#__PURE__*/function () {
   function EditorActions() {

package/dist/esm/version-wrapper.js

@@ -1,2 +1,2 @@
 export var name = "@atlaskit/editor-core";
-export var version = "204.7.2";
+export var version = "204.8.0";

package/dist/types/actions/index.d.ts

@@ -4,6 +4,14 @@ import type { EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
 import type { ContextUpdateHandler, EditorActionsOptions, FeatureFlags, ReplaceRawValue, GetResolvedEditorStateReason, Transformer } from '@atlaskit/editor-common/types';
 import { Node } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-26729 Internal documentation for deprecation (no external access)} Editor actions is no longer supported and will be removed in a future version. Please use the core actions, or Plugin APIs directly instead
+ * @example If you were using editorActions.getValue() replace with:
+    const { editorApi, preset } = usePreset(...);
+    editorApi?.core.actions.requestDocument((doc) => {
+        // use doc as desired
+    })
+ */
 export default class EditorActions<T = any> implements EditorActionsOptions<T> {
     private editorView?;
     private contentTransformer?;

package/dist/types-ts4.5/actions/index.d.ts

@@ -4,6 +4,14 @@ import type { EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
 import type { ContextUpdateHandler, EditorActionsOptions, FeatureFlags, ReplaceRawValue, GetResolvedEditorStateReason, Transformer } from '@atlaskit/editor-common/types';
 import { Node } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-26729 Internal documentation for deprecation (no external access)} Editor actions is no longer supported and will be removed in a future version. Please use the core actions, or Plugin APIs directly instead
+ * @example If you were using editorActions.getValue() replace with:
+    const { editorApi, preset } = usePreset(...);
+    editorApi?.core.actions.requestDocument((doc) => {
+        // use doc as desired
+    })
+ */
 export default class EditorActions<T = any> implements EditorActionsOptions<T> {
     private editorView?;
     private contentTransformer?;

package/docs/0-intro.tsx

@@ -18,17 +18,17 @@ ${(<AtlassianInternalWarning />)}
 
   ## Prerequisites
 
-  * **React 16:** at the time of writing, the Atlassian Editor is built on top of React 16 and doesn’t explicitly support any higher versions of React yet, which means both the \`react\` and \`react-dom\` libraries and their dependencies need to be set to React 16 compatible version.
+  * **React 18:** at the time of writing, the Atlassian Editor is built on top of React 18 and doesn’t explicitly support any higher versions of React yet, which means both the \`react\` and \`react-dom\` libraries and their dependencies need to be set to React 18 compatible version.
   * **Singleton:** the ProseMirror libraries in use and the document format \(Atlassian Document Format, ADF\) demand that some of the libraries using them are singletons, as multiple versions of the library will cause breaking issues. So, consumers of the Atlassian Editor need to enforce these singletons; this is usually done by deduplicating after installing the dependencies or by setting libraries to specific versions through resolutions to avoid multiple versions. Our recommendation is to use [yarn-deduplicate](https://www.npmjs.com/package/yarn-deduplicate).
 
   ## Installation
 
-  1. Install the editor libraries  
+  1. Install the editor libraries
     - **npm:** \`npm install --save @atlaskit/editor-core @atlaskit/css-reset\`
     - **yarn:** \`yarn add @atlaskit/editor-core @atlaskit/css-reset\`
 
   2. Deduplicate the dependencies \(if necessary\) by setting resolutions to avoid multiple versions of the editor libraries or by running [npm dedupe](https://docs.npmjs.com/cli/v6/commands/npm-dedupe) or [yarn dedupe](https://yarnpkg.com/cli/dedupe) after installation.
-  3. Setup the CSS reset in your application  
+  3. Setup the CSS reset in your application
     \`import '@atlaskit/css-reset';\`
 
   ## Usage
@@ -112,7 +112,7 @@ const createPreset = () =>
       }
       return builder; // Don't add the plugin
     });
-    
+
 const { preset } = usePreset(createPreset);
 `}
 
@@ -199,7 +199,7 @@ ${code`
   const createPreset = () =>
     createDefaultPreset({ featureFlags: {}, paste: {} });
   const { preset } = usePreset(createPreset);
-  
+
   return <ComposableEditor appearance='full-page' preset={preset} />;
   // Or full-width
   return <ComposableEditor appearance='full-width' preset={preset} />;
@@ -231,7 +231,7 @@ ${code`
 
   ### Collapsible Editor
 
-  Sometimes, you may not want to display the whole Editor initially, and you'd prefer to show it in a collapsed state so that users can expand it when needed. 
+  Sometimes, you may not want to display the whole Editor initially, and you'd prefer to show it in a collapsed state so that users can expand it when needed.
 
   Here's how you can implement this behavior:
 
@@ -368,7 +368,7 @@ function EditorInternal() {
   const { editorApi, preset } = usePreset(createPreset);
 
   // We memoise the transformer in case this component renders frequently
-  const transformer = useMemo(() => 
+  const transformer = useMemo(() =>
     editorApi?.core?.actions?.createTransformer((schema) => new BitbucketTransformer(schema))
   , [editorApi])
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "204.7.2",
+	"version": "204.8.0",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"