@atlaskit/editor-plugin-guideline 0.1.0

package/CHANGELOG.md

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

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 @@
+# EditorPluginGuideline
+
+guideline plugin for @atlaskit/editor-core
+
+## Usage
+
+`import EditorPluginGuideline from '@atlaskit/editor-plugin-guideline';`
+
+Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-guideline).

package/dist/cjs/index.js

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

package/dist/cjs/plugin.js

@@ -0,0 +1,74 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.guidelinePlugin = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _prosemirrorState = require("prosemirror-state");
+var _hooks = require("@atlaskit/editor-common/hooks");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var key = new _prosemirrorState.PluginKey('guidelinePlugin');
+var displayGuideline = function displayGuideline(_view) {};
+var EMPTY_STATE = {
+  guidelines: []
+};
+var guidelinePMPlugin = new _safePlugin.SafePlugin({
+  key: key,
+  state: {
+    init: function init() {
+      return EMPTY_STATE;
+    },
+    apply: function apply(tr, currentPluginState) {
+      var nextPluginState = tr.getMeta(key);
+      if (nextPluginState) {
+        return nextPluginState;
+      }
+      return currentPluginState;
+    }
+  }
+});
+var ContentComponent = function ContentComponent(_ref) {
+  var api = _ref.api,
+    editorView = _ref.editorView,
+    options = _ref.options;
+  var _useSharedPluginState = (0, _hooks.useSharedPluginState)(api, ['width', 'guideline']),
+    widthState = _useSharedPluginState.widthState,
+    guidelineState = _useSharedPluginState.guidelineState;
+  if (!guidelineState || !widthState) {
+    return null;
+  }
+  return /*#__PURE__*/_react.default.createElement("div", null);
+};
+var guidelinePlugin = function guidelinePlugin(options, api) {
+  return {
+    name: 'guideline',
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return null;
+      }
+      return key.getState(editorState);
+    },
+    actions: {
+      displayGuideline: displayGuideline
+    },
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'guideline',
+        plugin: function plugin() {
+          return guidelinePMPlugin;
+        }
+      }];
+    },
+    contentComponent: function contentComponent(_ref2) {
+      var editorView = _ref2.editorView;
+      return /*#__PURE__*/_react.default.createElement(ContentComponent, {
+        editorView: editorView,
+        options: options,
+        api: api
+      });
+    }
+  };
+};
+exports.guidelinePlugin = guidelinePlugin;

package/dist/cjs/types.js

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

package/dist/cjs/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-guideline",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/es2019/index.js

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

package/dist/es2019/plugin.js

@@ -0,0 +1,63 @@
+import React from 'react';
+import { PluginKey } from 'prosemirror-state';
+import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+const key = new PluginKey('guidelinePlugin');
+const displayGuideline = _view => {};
+const EMPTY_STATE = {
+  guidelines: []
+};
+const guidelinePMPlugin = new SafePlugin({
+  key,
+  state: {
+    init() {
+      return EMPTY_STATE;
+    },
+    apply(tr, currentPluginState) {
+      const nextPluginState = tr.getMeta(key);
+      if (nextPluginState) {
+        return nextPluginState;
+      }
+      return currentPluginState;
+    }
+  }
+});
+const ContentComponent = ({
+  api,
+  editorView,
+  options
+}) => {
+  const {
+    widthState,
+    guidelineState
+  } = useSharedPluginState(api, ['width', 'guideline']);
+  if (!guidelineState || !widthState) {
+    return null;
+  }
+  return /*#__PURE__*/React.createElement("div", null);
+};
+export const guidelinePlugin = (options, api) => ({
+  name: 'guideline',
+  getSharedState(editorState) {
+    if (!editorState) {
+      return null;
+    }
+    return key.getState(editorState);
+  },
+  actions: {
+    displayGuideline: displayGuideline
+  },
+  pmPlugins() {
+    return [{
+      name: 'guideline',
+      plugin: () => guidelinePMPlugin
+    }];
+  },
+  contentComponent: ({
+    editorView
+  }) => /*#__PURE__*/React.createElement(ContentComponent, {
+    editorView: editorView,
+    options: options,
+    api: api
+  })
+});

package/dist/es2019/types.js

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

package/dist/es2019/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-guideline",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/esm/index.js

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

package/dist/esm/plugin.js

@@ -0,0 +1,66 @@
+import React from 'react';
+import { PluginKey } from 'prosemirror-state';
+import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+var key = new PluginKey('guidelinePlugin');
+var displayGuideline = function displayGuideline(_view) {};
+var EMPTY_STATE = {
+  guidelines: []
+};
+var guidelinePMPlugin = new SafePlugin({
+  key: key,
+  state: {
+    init: function init() {
+      return EMPTY_STATE;
+    },
+    apply: function apply(tr, currentPluginState) {
+      var nextPluginState = tr.getMeta(key);
+      if (nextPluginState) {
+        return nextPluginState;
+      }
+      return currentPluginState;
+    }
+  }
+});
+var ContentComponent = function ContentComponent(_ref) {
+  var api = _ref.api,
+    editorView = _ref.editorView,
+    options = _ref.options;
+  var _useSharedPluginState = useSharedPluginState(api, ['width', 'guideline']),
+    widthState = _useSharedPluginState.widthState,
+    guidelineState = _useSharedPluginState.guidelineState;
+  if (!guidelineState || !widthState) {
+    return null;
+  }
+  return /*#__PURE__*/React.createElement("div", null);
+};
+export var guidelinePlugin = function guidelinePlugin(options, api) {
+  return {
+    name: 'guideline',
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return null;
+      }
+      return key.getState(editorState);
+    },
+    actions: {
+      displayGuideline: displayGuideline
+    },
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'guideline',
+        plugin: function plugin() {
+          return guidelinePMPlugin;
+        }
+      }];
+    },
+    contentComponent: function contentComponent(_ref2) {
+      var editorView = _ref2.editorView;
+      return /*#__PURE__*/React.createElement(ContentComponent, {
+        editorView: editorView,
+        options: options,
+        api: api
+      });
+    }
+  };
+};

package/dist/esm/types.js

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

package/dist/esm/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-guideline",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/types/index.d.ts

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

package/dist/types/plugin.d.ts

@@ -0,0 +1,10 @@
+import { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { widthPlugin } from '@atlaskit/editor-plugin-width';
+import { DisplayGuideline, GuidelinePluginState } from './types';
+export declare const guidelinePlugin: NextEditorPlugin<'guideline', {
+    dependencies: [typeof widthPlugin];
+    sharedState: GuidelinePluginState | null;
+    actions: {
+        displayGuideline: DisplayGuideline;
+    };
+}>;

package/dist/types/types.d.ts

@@ -0,0 +1,15 @@
+import { EditorView } from 'prosemirror-view';
+type Guideline = {
+    key?: string;
+    active?: boolean;
+    show?: boolean;
+    style?: 'dashed' | 'solid';
+    color?: string;
+};
+type GuidelinePluginState = {
+    guidelines: Guideline[];
+};
+interface GuidelinePluginOptions {
+}
+type DisplayGuideline = (view: EditorView) => void;
+export type { GuidelinePluginState, GuidelinePluginOptions, Guideline, DisplayGuideline, };

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

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

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

@@ -0,0 +1,12 @@
+import { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { widthPlugin } from '@atlaskit/editor-plugin-width';
+import { DisplayGuideline, GuidelinePluginState } from './types';
+export declare const guidelinePlugin: NextEditorPlugin<'guideline', {
+    dependencies: [
+        typeof widthPlugin
+    ];
+    sharedState: GuidelinePluginState | null;
+    actions: {
+        displayGuideline: DisplayGuideline;
+    };
+}>;

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

@@ -0,0 +1,15 @@
+import { EditorView } from 'prosemirror-view';
+type Guideline = {
+    key?: string;
+    active?: boolean;
+    show?: boolean;
+    style?: 'dashed' | 'solid';
+    color?: string;
+};
+type GuidelinePluginState = {
+    guidelines: Guideline[];
+};
+interface GuidelinePluginOptions {
+}
+type DisplayGuideline = (view: EditorView) => void;
+export type { GuidelinePluginState, GuidelinePluginOptions, Guideline, DisplayGuideline, };

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@atlaskit/editor-plugin-guideline",
+  "version": "0.1.0",
+  "description": "guideline plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor",
+    "releaseModel": "scheduled"
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/editor-common": "^74.2.0",
+    "@atlaskit/editor-plugin-width": "^0.0.1",
+    "@babel/runtime": "^7.0.0",
+    "prosemirror-state": "1.3.4",
+    "prosemirror-view": "1.23.7"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@atlaskit/docs": "*",
+    "@atlaskit/editor-core": "^184.0.0",
+    "@atlaskit/editor-test-helpers": "^18.2.0",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "react-dom": "^16.8.0",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "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",
+        "emotion"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,66 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/editor-plugin-guideline"
+
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+import { EditorView } from 'prosemirror-view';
+import { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { widthPlugin } from '@atlaskit/editor-plugin-width';
+
+// @public (undocumented)
+type DisplayGuideline = (view: EditorView) => void;
+
+// @public (undocumented)
+type Guideline = {
+  key?: string;
+  active?: boolean;
+  show?: boolean;
+  style?: 'dashed' | 'solid';
+  color?: string;
+};
+
+// @public (undocumented)
+export const guidelinePlugin: NextEditorPlugin<
+  'guideline',
+  {
+    dependencies: [typeof widthPlugin];
+    sharedState: GuidelinePluginState | null;
+    actions: {
+      displayGuideline: DisplayGuideline;
+    };
+  }
+>;
+
+// @public (undocumented)
+type GuidelinePluginState = {
+  guidelines: Guideline[];
+};
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->