@atlaskit/editor-plugin-highlight 1.0.0

package/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  rules: {
+    '@typescript-eslint/no-duplicate-imports': 'error',
+    '@typescript-eslint/no-explicit-any': 'error',
+  },
+};

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/editor-plugin-highlight

package/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2023 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,9 @@
+# EditorPluginHighlight
+
+Highlight plugin for @atlaskit/editor-core
+
+## Usage
+
+`import EditorPluginHighlight from '@atlaskit/editor-plugins/highlight';`
+
+Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-highlight).

package/dist/cjs/index.js

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

package/dist/cjs/plugin.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.highlightPlugin = void 0;
+var _pmPlugin = require("./pm-plugin");
+// TODO: Uncomment once ADF schema change rolled out in AFM
+// import { backgroundColor } from '@atlaskit/adf-schema';
+
+var highlightPlugin = exports.highlightPlugin = function highlightPlugin(_ref) {
+  var api = _ref.api;
+  return {
+    name: 'highlight',
+    // TODO: Uncomment once ADF schema change rolled out in AFM
+    // marks() {
+    //   return [{ name: 'backgroundColor', mark: backgroundColor }];
+    // },
+
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'highlight',
+        plugin: function plugin() {
+          return (0, _pmPlugin.createPlugin)({
+            api: api
+          });
+        }
+      }];
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return;
+      }
+      return _pmPlugin.highlightPluginKey.getState(editorState);
+    } // Add highlight toolbar button to primary toolbar
+    // primaryToolbarComponent({ disabled }) {
+    // TODO: Implement primary toolbar UI
+    // },
+  };
+};

package/dist/cjs/pm-plugin.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.highlightPluginKey = exports.createPlugin = void 0;
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var highlightPluginKey = exports.highlightPluginKey = new _state.PluginKey('highlight');
+var createPlugin = exports.createPlugin = function createPlugin(_ref) {
+  var api = _ref.api;
+  return new _safePlugin.SafePlugin({
+    key: highlightPluginKey
+  });
+};

package/dist/es2019/index.js

@@ -0,0 +1 @@
+export { highlightPlugin } from './plugin';

package/dist/es2019/plugin.js

@@ -0,0 +1,32 @@
+import { createPlugin, highlightPluginKey } from './pm-plugin';
+
+// TODO: Uncomment once ADF schema change rolled out in AFM
+// import { backgroundColor } from '@atlaskit/adf-schema';
+
+export const highlightPlugin = ({
+  api
+}) => ({
+  name: 'highlight',
+  // TODO: Uncomment once ADF schema change rolled out in AFM
+  // marks() {
+  //   return [{ name: 'backgroundColor', mark: backgroundColor }];
+  // },
+
+  pmPlugins: () => [{
+    name: 'highlight',
+    plugin: () => createPlugin({
+      api
+    })
+  }],
+  getSharedState(editorState) {
+    if (!editorState) {
+      return;
+    }
+    return highlightPluginKey.getState(editorState);
+  }
+
+  // Add highlight toolbar button to primary toolbar
+  // primaryToolbarComponent({ disabled }) {
+  // TODO: Implement primary toolbar UI
+  // },
+});

package/dist/es2019/pm-plugin.js

@@ -0,0 +1,10 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export const highlightPluginKey = new PluginKey('highlight');
+export const createPlugin = ({
+  api
+}) => {
+  return new SafePlugin({
+    key: highlightPluginKey
+  });
+};

package/dist/esm/index.js

@@ -0,0 +1 @@
+export { highlightPlugin } from './plugin';

package/dist/esm/plugin.js

@@ -0,0 +1,35 @@
+import { createPlugin, highlightPluginKey } from './pm-plugin';
+
+// TODO: Uncomment once ADF schema change rolled out in AFM
+// import { backgroundColor } from '@atlaskit/adf-schema';
+
+export var highlightPlugin = function highlightPlugin(_ref) {
+  var api = _ref.api;
+  return {
+    name: 'highlight',
+    // TODO: Uncomment once ADF schema change rolled out in AFM
+    // marks() {
+    //   return [{ name: 'backgroundColor', mark: backgroundColor }];
+    // },
+
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'highlight',
+        plugin: function plugin() {
+          return createPlugin({
+            api: api
+          });
+        }
+      }];
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return;
+      }
+      return highlightPluginKey.getState(editorState);
+    } // Add highlight toolbar button to primary toolbar
+    // primaryToolbarComponent({ disabled }) {
+    // TODO: Implement primary toolbar UI
+    // },
+  };
+};

package/dist/esm/pm-plugin.js

@@ -0,0 +1,9 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export var highlightPluginKey = new PluginKey('highlight');
+export var createPlugin = function createPlugin(_ref) {
+  var api = _ref.api;
+  return new SafePlugin({
+    key: highlightPluginKey
+  });
+};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { highlightPlugin } from './plugin';
+export type { HighlightPlugin } from './plugin';

package/dist/types/plugin.d.ts

@@ -0,0 +1,12 @@
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { TextFormattingPlugin } from '@atlaskit/editor-plugin-text-formatting';
+import type { HighlightPluginState } from './pm-plugin';
+export type HighlightPlugin = NextEditorPlugin<'highlight', {
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<TextFormattingPlugin>
+    ];
+    sharedState: HighlightPluginState | undefined;
+}>;
+export declare const highlightPlugin: HighlightPlugin;

package/dist/types/pm-plugin.d.ts

@@ -0,0 +1,10 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { HighlightPlugin } from './plugin';
+export interface HighlightPluginState {
+}
+export declare const highlightPluginKey: PluginKey<HighlightPluginState>;
+export declare const createPlugin: ({ api, }: {
+    api: ExtractInjectionAPI<HighlightPlugin> | undefined;
+}) => SafePlugin<any>;

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

@@ -0,0 +1,2 @@
+export { highlightPlugin } from './plugin';
+export type { HighlightPlugin } from './plugin';

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

@@ -0,0 +1,12 @@
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { TextFormattingPlugin } from '@atlaskit/editor-plugin-text-formatting';
+import type { HighlightPluginState } from './pm-plugin';
+export type HighlightPlugin = NextEditorPlugin<'highlight', {
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<TextFormattingPlugin>
+    ];
+    sharedState: HighlightPluginState | undefined;
+}>;
+export declare const highlightPlugin: HighlightPlugin;

package/dist/types-ts4.5/pm-plugin.d.ts

@@ -0,0 +1,10 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { HighlightPlugin } from './plugin';
+export interface HighlightPluginState {
+}
+export declare const highlightPluginKey: PluginKey<HighlightPluginState>;
+export declare const createPlugin: ({ api, }: {
+    api: ExtractInjectionAPI<HighlightPlugin> | undefined;
+}) => SafePlugin<any>;

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@atlaskit/editor-plugin-highlight",
+  "version": "1.0.0",
+  "description": "Highlight plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor: Core Experiences",
+    "inPublicMirror": false,
+    "releaseModel": "continuous",
+    "website": {
+      "name": "EditorPluginHighlight",
+      "category": "Components"
+    },
+    "runReact18": false
+  },
+  "repository": "https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo",
+  "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 <5.4": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/editor-common": "^78.32.0",
+    "@atlaskit/editor-plugin-analytics": "^1.1.0",
+    "@atlaskit/editor-plugin-text-formatting": "^1.4.0",
+    "@atlaskit/editor-prosemirror": "4.0.0",
+    "@babel/runtime": "^7.0.0"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "typescript": "~5.4.2"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "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": [
+        "static",
+        "compiled"
+      ],
+      "imports": [
+        "import-no-extraneous-disable-for-examples-and-docs"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0",
+  "stricter": {
+    "no-unused-dependencies": {
+      "checkDevDependencies": true
+    }
+  }
+}