@atlaskit/editor-core 205.7.0 → 205.7.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-core
 
+## 205.7.1
+
+### Patch Changes
+
+- [#145932](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/145932)
+  [`c771b0db325a2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c771b0db325a2) -
+  Add comment to show example how to migrate editorActions.getNodeByLocalId to the editorAPI
+  equivalent
+
 ## 205.7.0
 
 ### Minor Changes

package/dist/cjs/actions/index.js

@@ -41,7 +41,15 @@ var fakePluginKey = {
 	editorApi?.core.actions.requestDocument((doc) => {
   		// use doc as desired
 	})
- */
+
+ * If you were using editorActions.getNodeByLocalId(localId) replace with:
+	 	const { editorApi, preset } = usePreset(...);
+		const extensionAPI = editorAPI?.extension?.actions?.api();
+		// Use nodeWithPos as desired 
+		const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+		const node = nodeWithPos.node;
+		const nodePos = nodeWithPos.pos;
+*/
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 var EditorActions = exports.default = /*#__PURE__*/function () {
   function EditorActions() {
@@ -295,7 +303,17 @@ var EditorActions = exports.default = /*#__PURE__*/function () {
         return _getValue.apply(this, arguments);
       }
       return getValue;
-    }()
+    }() // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
+    /**
+     * @deprecated - please use `getNodeWithPosByLocalId` found in the core plugin actions instead
+     * @example 
+      	const { editorApi, preset } = usePreset(...);
+    	const extensionAPI = editorAPI?.extension?.actions?.api();
+    	// Use nodeWithPos as desired
+    	const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+    	const node = nodeWithPos.node;
+    	const nodePos = nodeWithPos.pos;
+     */
   }, {
     key: "getNodeByLocalId",
     value: function getNodeByLocalId(id) {

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 = "205.7.0";
+var version = exports.version = "205.7.1";

package/dist/es2019/actions/index.js

@@ -31,7 +31,15 @@ const fakePluginKey = {
 	editorApi?.core.actions.requestDocument((doc) => {
   		// use doc as desired
 	})
- */
+
+ * If you were using editorActions.getNodeByLocalId(localId) replace with:
+	 	const { editorApi, preset } = usePreset(...);
+		const extensionAPI = editorAPI?.extension?.actions?.api();
+		// Use nodeWithPos as desired 
+		const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+		const node = nodeWithPos.node;
+		const nodePos = nodeWithPos.pos;
+*/
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export default class EditorActions {
   constructor() {
@@ -213,6 +221,18 @@ export default class EditorActions {
       throw e;
     }
   }
+
+  // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
+  /**
+   * @deprecated - please use `getNodeWithPosByLocalId` found in the core plugin actions instead
+   * @example 
+    	const { editorApi, preset } = usePreset(...);
+  	const extensionAPI = editorAPI?.extension?.actions?.api();
+  	// Use nodeWithPos as desired
+  	const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+  	const node = nodeWithPos.node;
+  	const nodePos = nodeWithPos.pos;
+   */
   getNodeByLocalId(id) {
     var _this$editorView;
     if ((_this$editorView = this.editorView) !== null && _this$editorView !== void 0 && _this$editorView.state) {

package/dist/es2019/version-wrapper.js

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

package/dist/esm/actions/index.js

@@ -35,7 +35,15 @@ var fakePluginKey = {
 	editorApi?.core.actions.requestDocument((doc) => {
   		// use doc as desired
 	})
- */
+
+ * If you were using editorActions.getNodeByLocalId(localId) replace with:
+	 	const { editorApi, preset } = usePreset(...);
+		const extensionAPI = editorAPI?.extension?.actions?.api();
+		// Use nodeWithPos as desired 
+		const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+		const node = nodeWithPos.node;
+		const nodePos = nodeWithPos.pos;
+*/
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 var EditorActions = /*#__PURE__*/function () {
   function EditorActions() {
@@ -289,7 +297,17 @@ var EditorActions = /*#__PURE__*/function () {
         return _getValue.apply(this, arguments);
       }
       return getValue;
-    }()
+    }() // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883
+    /**
+     * @deprecated - please use `getNodeWithPosByLocalId` found in the core plugin actions instead
+     * @example 
+      	const { editorApi, preset } = usePreset(...);
+    	const extensionAPI = editorAPI?.extension?.actions?.api();
+    	// Use nodeWithPos as desired
+    	const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+    	const node = nodeWithPos.node;
+    	const nodePos = nodeWithPos.pos;
+     */
   }, {
     key: "getNodeByLocalId",
     value: function getNodeByLocalId(id) {

package/dist/esm/version-wrapper.js

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

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

@@ -11,7 +11,15 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
     editorApi?.core.actions.requestDocument((doc) => {
         // use doc as desired
     })
- */
+
+ * If you were using editorActions.getNodeByLocalId(localId) replace with:
+        const { editorApi, preset } = usePreset(...);
+        const extensionAPI = editorAPI?.extension?.actions?.api();
+        // Use nodeWithPos as desired
+        const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+        const node = nodeWithPos.node;
+        const nodePos = nodeWithPos.pos;
+*/
 export default class EditorActions<T = any> implements EditorActionsOptions<T> {
     private editorView?;
     private contentTransformer?;
@@ -42,6 +50,16 @@ export default class EditorActions<T = any> implements EditorActionsOptions<T> {
      * WARNING: this may be called repeatedly, async with care
      */
     getValue(): Promise<import("@atlaskit/editor-json-transformer").JSONDocNode | T | undefined>;
+    /**
+     * @deprecated - please use `getNodeWithPosByLocalId` found in the core plugin actions instead
+     * @example
+        const { editorApi, preset } = usePreset(...);
+        const extensionAPI = editorAPI?.extension?.actions?.api();
+        // Use nodeWithPos as desired
+        const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+        const node = nodeWithPos.node;
+        const nodePos = nodeWithPos.pos;
+     */
     getNodeByLocalId(id: string): Node | undefined;
     getNodeByFragmentLocalId(id: string): Node | undefined;
     /**

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

@@ -11,7 +11,15 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
     editorApi?.core.actions.requestDocument((doc) => {
         // use doc as desired
     })
- */
+
+ * If you were using editorActions.getNodeByLocalId(localId) replace with:
+        const { editorApi, preset } = usePreset(...);
+        const extensionAPI = editorAPI?.extension?.actions?.api();
+        // Use nodeWithPos as desired
+        const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+        const node = nodeWithPos.node;
+        const nodePos = nodeWithPos.pos;
+*/
 export default class EditorActions<T = any> implements EditorActionsOptions<T> {
     private editorView?;
     private contentTransformer?;
@@ -42,6 +50,16 @@ export default class EditorActions<T = any> implements EditorActionsOptions<T> {
      * WARNING: this may be called repeatedly, async with care
      */
     getValue(): Promise<import("@atlaskit/editor-json-transformer").JSONDocNode | T | undefined>;
+    /**
+     * @deprecated - please use `getNodeWithPosByLocalId` found in the core plugin actions instead
+     * @example
+        const { editorApi, preset } = usePreset(...);
+        const extensionAPI = editorAPI?.extension?.actions?.api();
+        // Use nodeWithPos as desired
+        const nodeWithPos = extensionAPI.getNodeWithPosByLocalId(localId);
+        const node = nodeWithPos.node;
+        const nodePos = nodeWithPos.pos;
+     */
     getNodeByLocalId(id: string): Node | undefined;
     getNodeByFragmentLocalId(id: string): Node | undefined;
     /**

package/package.json

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