@atlaskit/editor-plugin-local-id 3.3.0 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @atlaskit/editor-plugin-local-id
 
+## 4.1.0
+
+### Minor Changes
+
+- [`1b290cb1f993b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1b290cb1f993b) -
+  Adds actions to get and replace nodes by their localId
+
+  ```ts
+  // Replace a local id with a ProseMirror node
+  api?.localId.actions.replaceNode({ localId: 'example-id', value: node });
+
+  // Get a prosemirror node based on its local id
+  api?.localId.actions.getNode({ localId: 'example-id' });
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
+## 4.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.3.0
 
 ### Minor Changes

package/dist/cjs/editor-actions/index.js

@@ -0,0 +1,54 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.findNodeByLocalId = findNodeByLocalId;
+exports.replaceNode = exports.getNode = void 0;
+function findNodeByLocalId(tr, localId) {
+  var result;
+  tr.doc.descendants(function (node, pos) {
+    if (result) {
+      return false;
+    }
+    if (node.attrs.localId === localId) {
+      result = {
+        node: node,
+        pos: pos
+      };
+    }
+    return result === undefined;
+  });
+  return result;
+}
+var replaceNode = exports.replaceNode = function replaceNode(api) {
+  return function (_ref) {
+    var _api$core$actions$exe;
+    var localId = _ref.localId,
+      value = _ref.value;
+    var nodeWithPos = getNode(api)({
+      localId: localId
+    });
+    if (!nodeWithPos) {
+      return false;
+    }
+    var pos = nodeWithPos.pos,
+      node = nodeWithPos.node;
+    return (_api$core$actions$exe = api === null || api === void 0 ? void 0 : api.core.actions.execute(function (_ref2) {
+      var tr = _ref2.tr;
+      return tr.replaceWith(pos, pos + node.nodeSize, value).scrollIntoView();
+    })) !== null && _api$core$actions$exe !== void 0 ? _api$core$actions$exe : false;
+  };
+};
+var getNode = exports.getNode = function getNode(api) {
+  return function (_ref3) {
+    var localId = _ref3.localId;
+    var result;
+    api === null || api === void 0 || api.core.actions.execute(function (_ref4) {
+      var tr = _ref4.tr;
+      result = findNodeByLocalId(tr, localId);
+      return null;
+    });
+    return result;
+  };
+};

package/dist/cjs/localIdPlugin.js

@@ -4,10 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.localIdPlugin = void 0;
+var _editorActions = require("./editor-actions");
 var _main = require("./pm-plugins/main");
-var localIdPlugin = exports.localIdPlugin = function localIdPlugin() {
+var localIdPlugin = exports.localIdPlugin = function localIdPlugin(_ref) {
+  var api = _ref.api;
   return {
     name: 'localId',
+    actions: {
+      replaceNode: (0, _editorActions.replaceNode)(api),
+      getNode: (0, _editorActions.getNode)(api)
+    },
     pmPlugins: function pmPlugins() {
       return [{
         name: 'localIdPlugin',

package/dist/es2019/editor-actions/index.js

@@ -0,0 +1,47 @@
+export function findNodeByLocalId(tr, localId) {
+  let result;
+  tr.doc.descendants((node, pos) => {
+    if (result) {
+      return false;
+    }
+    if (node.attrs.localId === localId) {
+      result = {
+        node,
+        pos
+      };
+    }
+    return result === undefined;
+  });
+  return result;
+}
+export const replaceNode = api => ({
+  localId,
+  value
+}) => {
+  var _api$core$actions$exe;
+  const nodeWithPos = getNode(api)({
+    localId
+  });
+  if (!nodeWithPos) {
+    return false;
+  }
+  const {
+    pos,
+    node
+  } = nodeWithPos;
+  return (_api$core$actions$exe = api === null || api === void 0 ? void 0 : api.core.actions.execute(({
+    tr
+  }) => tr.replaceWith(pos, pos + node.nodeSize, value).scrollIntoView())) !== null && _api$core$actions$exe !== void 0 ? _api$core$actions$exe : false;
+};
+export const getNode = api => ({
+  localId
+}) => {
+  let result;
+  api === null || api === void 0 ? void 0 : api.core.actions.execute(({
+    tr
+  }) => {
+    result = findNodeByLocalId(tr, localId);
+    return null;
+  });
+  return result;
+};

package/dist/es2019/localIdPlugin.js

@@ -1,6 +1,13 @@
+import { replaceNode, getNode } from './editor-actions';
 import { createPlugin } from './pm-plugins/main';
-export const localIdPlugin = () => ({
+export const localIdPlugin = ({
+  api
+}) => ({
   name: 'localId',
+  actions: {
+    replaceNode: replaceNode(api),
+    getNode: getNode(api)
+  },
   pmPlugins() {
     return [{
       name: 'localIdPlugin',

package/dist/esm/editor-actions/index.js

@@ -0,0 +1,47 @@
+export function findNodeByLocalId(tr, localId) {
+  var result;
+  tr.doc.descendants(function (node, pos) {
+    if (result) {
+      return false;
+    }
+    if (node.attrs.localId === localId) {
+      result = {
+        node: node,
+        pos: pos
+      };
+    }
+    return result === undefined;
+  });
+  return result;
+}
+export var replaceNode = function replaceNode(api) {
+  return function (_ref) {
+    var _api$core$actions$exe;
+    var localId = _ref.localId,
+      value = _ref.value;
+    var nodeWithPos = getNode(api)({
+      localId: localId
+    });
+    if (!nodeWithPos) {
+      return false;
+    }
+    var pos = nodeWithPos.pos,
+      node = nodeWithPos.node;
+    return (_api$core$actions$exe = api === null || api === void 0 ? void 0 : api.core.actions.execute(function (_ref2) {
+      var tr = _ref2.tr;
+      return tr.replaceWith(pos, pos + node.nodeSize, value).scrollIntoView();
+    })) !== null && _api$core$actions$exe !== void 0 ? _api$core$actions$exe : false;
+  };
+};
+export var getNode = function getNode(api) {
+  return function (_ref3) {
+    var localId = _ref3.localId;
+    var result;
+    api === null || api === void 0 || api.core.actions.execute(function (_ref4) {
+      var tr = _ref4.tr;
+      result = findNodeByLocalId(tr, localId);
+      return null;
+    });
+    return result;
+  };
+};

package/dist/esm/localIdPlugin.js

@@ -1,7 +1,13 @@
+import { replaceNode, getNode } from './editor-actions';
 import { createPlugin } from './pm-plugins/main';
-export var localIdPlugin = function localIdPlugin() {
+export var localIdPlugin = function localIdPlugin(_ref) {
+  var api = _ref.api;
   return {
     name: 'localId',
+    actions: {
+      replaceNode: replaceNode(api),
+      getNode: getNode(api)
+    },
     pmPlugins: function pmPlugins() {
       return [{
         name: 'localIdPlugin',

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

@@ -0,0 +1,12 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+import type { Transform } from '@atlaskit/editor-prosemirror/transform';
+import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
+import type { ActionProps, LocalIdPlugin } from '../localIdPluginType';
+type EditorActionProps = ActionProps;
+export declare function findNodeByLocalId(tr: Transform, localId: string): NodeWithPos | undefined;
+export declare const replaceNode: (api: ExtractInjectionAPI<LocalIdPlugin> | undefined) => ({ localId, value }: EditorActionProps & {
+    value: Node;
+}) => boolean;
+export declare const getNode: (api: ExtractInjectionAPI<LocalIdPlugin> | undefined) => ({ localId }: EditorActionProps) => NodeWithPos | undefined;
+export {};

package/dist/types/localIdPluginType.d.ts

@@ -1,2 +1,27 @@
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
-export type LocalIdPlugin = NextEditorPlugin<'localId'>;
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
+export type ActionProps = {
+    localId: string;
+};
+export type LocalIdPlugin = NextEditorPlugin<'localId', {
+    actions: {
+        /**
+         * Get the node with its position in the document
+         *
+         * @param props.localId Local id of the node in question
+         * @returns { node: ProsemirrorNode, pos: number } Object containing prosemirror node and position in the document
+         */
+        getNode: (props: ActionProps) => NodeWithPos | undefined;
+        /**
+         * Replace the node in the document by its local id
+         *
+         * @param props.localId Local id of the node in question
+         * @param props.value Prosemirror node to replace the node with
+         * @returns boolean if the replace was successful
+         */
+        replaceNode: (props: ActionProps & {
+            value: Node;
+        }) => boolean;
+    };
+}>;

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

@@ -0,0 +1,12 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+import type { Transform } from '@atlaskit/editor-prosemirror/transform';
+import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
+import type { ActionProps, LocalIdPlugin } from '../localIdPluginType';
+type EditorActionProps = ActionProps;
+export declare function findNodeByLocalId(tr: Transform, localId: string): NodeWithPos | undefined;
+export declare const replaceNode: (api: ExtractInjectionAPI<LocalIdPlugin> | undefined) => ({ localId, value }: EditorActionProps & {
+    value: Node;
+}) => boolean;
+export declare const getNode: (api: ExtractInjectionAPI<LocalIdPlugin> | undefined) => ({ localId }: EditorActionProps) => NodeWithPos | undefined;
+export {};

package/dist/types-ts4.5/localIdPluginType.d.ts

@@ -1,2 +1,27 @@
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
-export type LocalIdPlugin = NextEditorPlugin<'localId'>;
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+import type { NodeWithPos } from '@atlaskit/editor-prosemirror/utils';
+export type ActionProps = {
+    localId: string;
+};
+export type LocalIdPlugin = NextEditorPlugin<'localId', {
+    actions: {
+        /**
+         * Get the node with its position in the document
+         *
+         * @param props.localId Local id of the node in question
+         * @returns { node: ProsemirrorNode, pos: number } Object containing prosemirror node and position in the document
+         */
+        getNode: (props: ActionProps) => NodeWithPos | undefined;
+        /**
+         * Replace the node in the document by its local id
+         *
+         * @param props.localId Local id of the node in question
+         * @param props.value Prosemirror node to replace the node with
+         * @returns boolean if the replace was successful
+         */
+        replaceNode: (props: ActionProps & {
+            value: Node;
+        }) => boolean;
+    };
+}>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-local-id",
-	"version": "3.3.0",
+	"version": "4.1.0",
 	"description": "LocalId plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -35,7 +35,7 @@
 		"raf-schd": "^4.0.3"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^109.16.0",
+		"@atlaskit/editor-common": "^110.4.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {