@atlaskit/editor-plugin-local-id 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @atlaskit/editor-plugin-local-id
+
+## 1.0.0
+
+### Major Changes
+
+- [#197573](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/197573)
+  [`65dfe86479bb2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/65dfe86479bb2) -
+  EDITOR-1101 Setup new package scaffold
+
+### Patch Changes
+
+- Updated dependencies

package/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2019 Atlassian Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is
+distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions and limitations under the
+License.

package/README.md

@@ -0,0 +1,39 @@
+# Editor Plugin: `editor-plugin-local-id`
+
+## 🧠 Overview
+
+This plugin ensures that all non-ignored nodes in the document have unique `localId` attributes. It performs a **one-time scan** of the document when the editor is initialized to add missing local IDs to existing nodes.
+
+The plugin is designed to run only once per editor instance to avoid performance issues and prevent duplicate ID generation. It's optimized by using idle time scheduling and avoiding unnecessary transactions.
+
+---
+
+## ⚙️ How It Works
+
+### Core Mechanism
+- **Trigger**: Uses the editor view's initialization lifecycle to schedule the scan
+- **Execution**: Performs a single document traversal during browser idle time
+- **Scheduling**: Uses `requestIdleCallback` with `requestAnimationFrame` fallback for Safari
+
+### Node Processing
+For each node in the document:
+- **Ignored nodes**: Always skipped (no local IDs needed)
+- **Nodes with existing localId**: Left unchanged
+- **Nodes without localId**: New UUID generated and assigned
+
+### Transaction Handling
+- All node updates are batched into a single transaction (only when needed)
+- Transaction is marked with `addToHistory: false` to prevent undo/redo issues
+- No transactions are dispatched if no local IDs need to be added
+
+---
+
+## ✅ Behavior
+
+| Case | Action Taken | Transaction Impact |
+|------|-------------|-------------------|
+| Node has no `localId` and is not ignored | `localId` is added | Single transaction with all changes |
+| Node already has a `localId` | Left unchanged | No transaction |
+| Plugin has already run | No action taken | No transaction |
+| Document has no applicable nodes | No action taken | No transaction |
+

package/afm-cc/tsconfig.json

@@ -0,0 +1,24 @@
+{
+	"extends": "../../../../tsconfig.entry-points.confluence.json",
+	"compilerOptions": {
+		"target": "es5",
+		"composite": true,
+		"outDir": "../../../../../confluence/tsDist/@atlaskit__editor-plugin-local-id",
+		"rootDir": "../"
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-cc/tsconfig.json"
+		}
+	]
+}

package/afm-dev-agents/tsconfig.json

@@ -0,0 +1,24 @@
+{
+	"extends": "../../../../tsconfig.entry-points.dev-agents.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../dev-agents/tsDist/@atlaskit__editor-plugin-local-id/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-dev-agents/tsconfig.json"
+		}
+	]
+}

package/afm-jira/tsconfig.json

@@ -0,0 +1,24 @@
+{
+	"extends": "../../../../tsconfig.entry-points.jira.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../tsDist/@atlaskit__editor-plugin-local-id/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-jira/tsconfig.json"
+		}
+	]
+}

package/afm-post-office/tsconfig.json

@@ -0,0 +1,24 @@
+{
+	"extends": "../../../../tsconfig.entry-points.post-office.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../post-office/tsDist/@atlaskit__editor-plugin-local-id/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-post-office/tsconfig.json"
+		}
+	]
+}

package/afm-rovo-extension/tsconfig.json

@@ -0,0 +1,24 @@
+{
+	"extends": "../../../../tsconfig.entry-points.rovo-extension.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../rovo-extension/tsDist/@atlaskit__editor-plugin-local-id/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-rovo-extension/tsconfig.json"
+		}
+	]
+}

package/afm-townsquare/tsconfig.json

@@ -0,0 +1,24 @@
+{
+	"extends": "../../../../tsconfig.entry-points.townsquare.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../townsquare/tsDist/@atlaskit__editor-plugin-local-id/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-townsquare/tsconfig.json"
+		}
+	]
+}

package/build/tsconfig.json

@@ -0,0 +1,17 @@
+{
+	"extends": "../tsconfig",
+	"compilerOptions": {
+		"target": "es5",
+		"paths": {}
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	]
+}

package/dist/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "localIdPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _localIdPlugin.localIdPlugin;
+  }
+});
+var _localIdPlugin = require("./localIdPlugin");

package/dist/cjs/localIdPlugin.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.localIdPlugin = void 0;
+var _main = require("./pm-plugins/main");
+var localIdPlugin = exports.localIdPlugin = function localIdPlugin() {
+  return {
+    name: 'localId',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'localIdPlugin',
+        plugin: _main.createPlugin
+      }];
+    }
+  };
+};

package/dist/cjs/localIdPluginType.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/pm-plugins/main.js

@@ -0,0 +1,78 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.localIdPluginKey = exports.createPlugin = exports.addLocalIdToNode = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _adfSchema = require("@atlaskit/adf-schema");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _state = require("@atlaskit/editor-prosemirror/state");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var localIdPluginKey = exports.localIdPluginKey = new _state.PluginKey('localIdPlugin');
+
+// Fallback for Safari which doesn't support requestIdleCallback
+var requestIdleCallbackWithFallback = function requestIdleCallbackWithFallback(callback) {
+  if (typeof requestIdleCallback !== 'undefined') {
+    requestIdleCallback(callback);
+  } else {
+    // Fallback to requestAnimationFrame for Safari
+    requestAnimationFrame(callback);
+  }
+};
+var createPlugin = exports.createPlugin = function createPlugin() {
+  return new _safePlugin.SafePlugin({
+    key: localIdPluginKey,
+    view: function view(editorView) {
+      /**
+       * This performs a one-time scan of the document to add local IDs
+       * to nodes that don't have them. It's designed to run only once per
+       * editor instance to avoid performance issues.
+       */
+      requestIdleCallbackWithFallback(function () {
+        var tr = editorView.state.tr;
+        var localIdWasAdded = false;
+        var _editorView$state$sch = editorView.state.schema.nodes,
+          text = _editorView$state$sch.text,
+          hardBreak = _editorView$state$sch.hardBreak;
+        var ignoredNodeTypes = [text.name, hardBreak.name];
+        editorView.state.doc.descendants(function (node, pos) {
+          // Skip text nodes, hard breaks and nodes that already have local IDs
+          if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId) {
+            localIdWasAdded = true;
+            addLocalIdToNode(node, pos, tr);
+          }
+          return true; // Continue traversing
+        });
+
+        // Only dispatch the transaction if we actually added local IDs
+        if (localIdWasAdded) {
+          tr.setMeta('addToHistory', false);
+          editorView.dispatch(tr);
+        }
+      });
+      return {
+        update: function update() {}
+      };
+    }
+  });
+};
+
+/**
+ * Adds a local ID to a ProseMirror node
+ *
+ * This utility function updates a node's attributes to include a unique local ID.
+ * It preserves all existing attributes and marks while adding the new localId.
+ *
+ * @param node - The ProseMirror node to add a local ID to
+ * @param pos - The position of the node in the document
+ * @param tr - The transaction to apply the change to
+ * @returns The updated transaction with the node markup change
+ */
+var addLocalIdToNode = exports.addLocalIdToNode = function addLocalIdToNode(node, pos, tr) {
+  tr = tr.setNodeMarkup(pos, node.type, _objectSpread(_objectSpread({}, node.attrs), {}, {
+    localId: _adfSchema.uuid.generate()
+  }), node.marks);
+};

package/dist/es2019/index.js

@@ -0,0 +1,4 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { localIdPlugin } from './localIdPlugin';

package/dist/es2019/localIdPlugin.js

@@ -0,0 +1,10 @@
+import { createPlugin } from './pm-plugins/main';
+export const localIdPlugin = () => ({
+  name: 'localId',
+  pmPlugins() {
+    return [{
+      name: 'localIdPlugin',
+      plugin: createPlugin
+    }];
+  }
+});

package/dist/es2019/localIdPluginType.js

@@ -0,0 +1 @@
+export {};

package/dist/es2019/pm-plugins/main.js

@@ -0,0 +1,70 @@
+import { uuid } from '@atlaskit/adf-schema';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export const localIdPluginKey = new PluginKey('localIdPlugin');
+
+// Fallback for Safari which doesn't support requestIdleCallback
+const requestIdleCallbackWithFallback = callback => {
+  if (typeof requestIdleCallback !== 'undefined') {
+    requestIdleCallback(callback);
+  } else {
+    // Fallback to requestAnimationFrame for Safari
+    requestAnimationFrame(callback);
+  }
+};
+export const createPlugin = () => {
+  return new SafePlugin({
+    key: localIdPluginKey,
+    view: editorView => {
+      /**
+       * This performs a one-time scan of the document to add local IDs
+       * to nodes that don't have them. It's designed to run only once per
+       * editor instance to avoid performance issues.
+       */
+      requestIdleCallbackWithFallback(() => {
+        const tr = editorView.state.tr;
+        let localIdWasAdded = false;
+        const {
+          text,
+          hardBreak
+        } = editorView.state.schema.nodes;
+        const ignoredNodeTypes = [text.name, hardBreak.name];
+        editorView.state.doc.descendants((node, pos) => {
+          // Skip text nodes, hard breaks and nodes that already have local IDs
+          if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId) {
+            localIdWasAdded = true;
+            addLocalIdToNode(node, pos, tr);
+          }
+          return true; // Continue traversing
+        });
+
+        // Only dispatch the transaction if we actually added local IDs
+        if (localIdWasAdded) {
+          tr.setMeta('addToHistory', false);
+          editorView.dispatch(tr);
+        }
+      });
+      return {
+        update: () => {}
+      };
+    }
+  });
+};
+
+/**
+ * Adds a local ID to a ProseMirror node
+ *
+ * This utility function updates a node's attributes to include a unique local ID.
+ * It preserves all existing attributes and marks while adding the new localId.
+ *
+ * @param node - The ProseMirror node to add a local ID to
+ * @param pos - The position of the node in the document
+ * @param tr - The transaction to apply the change to
+ * @returns The updated transaction with the node markup change
+ */
+export const addLocalIdToNode = (node, pos, tr) => {
+  tr = tr.setNodeMarkup(pos, node.type, {
+    ...node.attrs,
+    localId: uuid.generate()
+  }, node.marks);
+};

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { localIdPlugin } from './localIdPlugin';

package/dist/esm/localIdPlugin.js

@@ -0,0 +1,12 @@
+import { createPlugin } from './pm-plugins/main';
+export var localIdPlugin = function localIdPlugin() {
+  return {
+    name: 'localId',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'localIdPlugin',
+        plugin: createPlugin
+      }];
+    }
+  };
+};

package/dist/esm/localIdPluginType.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/pm-plugins/main.js

@@ -0,0 +1,71 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { uuid } from '@atlaskit/adf-schema';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export var localIdPluginKey = new PluginKey('localIdPlugin');
+
+// Fallback for Safari which doesn't support requestIdleCallback
+var requestIdleCallbackWithFallback = function requestIdleCallbackWithFallback(callback) {
+  if (typeof requestIdleCallback !== 'undefined') {
+    requestIdleCallback(callback);
+  } else {
+    // Fallback to requestAnimationFrame for Safari
+    requestAnimationFrame(callback);
+  }
+};
+export var createPlugin = function createPlugin() {
+  return new SafePlugin({
+    key: localIdPluginKey,
+    view: function view(editorView) {
+      /**
+       * This performs a one-time scan of the document to add local IDs
+       * to nodes that don't have them. It's designed to run only once per
+       * editor instance to avoid performance issues.
+       */
+      requestIdleCallbackWithFallback(function () {
+        var tr = editorView.state.tr;
+        var localIdWasAdded = false;
+        var _editorView$state$sch = editorView.state.schema.nodes,
+          text = _editorView$state$sch.text,
+          hardBreak = _editorView$state$sch.hardBreak;
+        var ignoredNodeTypes = [text.name, hardBreak.name];
+        editorView.state.doc.descendants(function (node, pos) {
+          // Skip text nodes, hard breaks and nodes that already have local IDs
+          if (!ignoredNodeTypes.includes(node.type.name) && !node.attrs.localId) {
+            localIdWasAdded = true;
+            addLocalIdToNode(node, pos, tr);
+          }
+          return true; // Continue traversing
+        });
+
+        // Only dispatch the transaction if we actually added local IDs
+        if (localIdWasAdded) {
+          tr.setMeta('addToHistory', false);
+          editorView.dispatch(tr);
+        }
+      });
+      return {
+        update: function update() {}
+      };
+    }
+  });
+};
+
+/**
+ * Adds a local ID to a ProseMirror node
+ *
+ * This utility function updates a node's attributes to include a unique local ID.
+ * It preserves all existing attributes and marks while adding the new localId.
+ *
+ * @param node - The ProseMirror node to add a local ID to
+ * @param pos - The position of the node in the document
+ * @param tr - The transaction to apply the change to
+ * @returns The updated transaction with the node markup change
+ */
+export var addLocalIdToNode = function addLocalIdToNode(node, pos, tr) {
+  tr = tr.setNodeMarkup(pos, node.type, _objectSpread(_objectSpread({}, node.attrs), {}, {
+    localId: uuid.generate()
+  }), node.marks);
+};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { localIdPlugin } from './localIdPlugin';
+export type { LocalIdPlugin } from './localIdPluginType';

package/dist/types/localIdPlugin.d.ts

@@ -0,0 +1,2 @@
+import type { LocalIdPlugin } from './localIdPluginType';
+export declare const localIdPlugin: LocalIdPlugin;

package/dist/types/localIdPluginType.d.ts

@@ -0,0 +1,2 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type LocalIdPlugin = NextEditorPlugin<'localId'>;

package/dist/types/pm-plugins/main.d.ts

@@ -0,0 +1,17 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import { PluginKey, type Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const localIdPluginKey: PluginKey<any>;
+export declare const createPlugin: () => SafePlugin<any>;
+/**
+ * Adds a local ID to a ProseMirror node
+ *
+ * This utility function updates a node's attributes to include a unique local ID.
+ * It preserves all existing attributes and marks while adding the new localId.
+ *
+ * @param node - The ProseMirror node to add a local ID to
+ * @param pos - The position of the node in the document
+ * @param tr - The transaction to apply the change to
+ * @returns The updated transaction with the node markup change
+ */
+export declare const addLocalIdToNode: (node: PMNode, pos: number, tr: Transaction) => void;

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

@@ -0,0 +1,2 @@
+export { localIdPlugin } from './localIdPlugin';
+export type { LocalIdPlugin } from './localIdPluginType';

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

@@ -0,0 +1,2 @@
+import type { LocalIdPlugin } from './localIdPluginType';
+export declare const localIdPlugin: LocalIdPlugin;

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

@@ -0,0 +1,2 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type LocalIdPlugin = NextEditorPlugin<'localId'>;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -0,0 +1,17 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import { PluginKey, type Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const localIdPluginKey: PluginKey<any>;
+export declare const createPlugin: () => SafePlugin<any>;
+/**
+ * Adds a local ID to a ProseMirror node
+ *
+ * This utility function updates a node's attributes to include a unique local ID.
+ * It preserves all existing attributes and marks while adding the new localId.
+ *
+ * @param node - The ProseMirror node to add a local ID to
+ * @param pos - The position of the node in the document
+ * @param tr - The transaction to apply the change to
+ * @returns The updated transaction with the node markup change
+ */
+export declare const addLocalIdToNode: (node: PMNode, pos: number, tr: Transaction) => void;

package/docs/0-intro.tsx

@@ -0,0 +1,43 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
+import { token } from '@atlaskit/tokens';
+
+export default md`
+
+${createEditorUseOnlyNotice('Editor Plugin Local Id', [
+	{ name: 'Editor Core', link: '/packages/editor/editor-core' },
+])}
+
+
+  ${
+		(
+			// eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
+			<div style={{ marginTop: token('space.100', '8px') }}>
+				<AtlassianInternalWarning />
+			</div>
+		)
+	}
+
+  This package includes the local id plugin used by \`@atlaskit/editor-core\`.
+
+  ## Usage
+---
+
+The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\` of the plugin are defined
+below:
+
+${code`
+type LocalIdPlugin = NextEditorPlugin<'localId'>
+`}
+
+
+  ## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
+`;

package/package.json

@@ -0,0 +1,82 @@
+{
+	"name": "@atlaskit/editor-plugin-local-id",
+	"version": "1.0.0",
+	"description": "LocalId plugin for @atlaskit/editor-core",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "Editor: Lego",
+		"releaseModel": "continuous",
+		"singleton": true
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": false,
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts"
+	},
+	"dependencies": {
+		"@atlaskit/adf-schema": "^50.2.0",
+		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@babel/runtime": "^7.0.0",
+		"raf-schd": "^4.0.3"
+	},
+	"peerDependencies": {
+		"@atlaskit/editor-common": "^107.18.0",
+		"react": "^18.2.0"
+	},
+	"devDependencies": {
+		"typescript": "~5.4.2"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"code-structure": [
+				"editor-plugin"
+			],
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			]
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
+			"deprecation": "no-deprecated-imports",
+			"styling": [
+				"emotion",
+				"emotion"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	}
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../../../tsconfig.json",
+	"include": [
+		"src/**/*.ts",
+		"src/**/*.tsx"
+	],
+	"compilerOptions": {}
+}