@atlaskit/editor-plugin-guideline 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @atlaskit/editor-plugin-guideline
 
+## 0.5.0
+
+### Minor Changes
+
+- [`ad3c5c21079`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ad3c5c21079) - Updating all plugins with minor version to correct issue with semver.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 0.4.2
+
+### Patch Changes
+
+- [`8467bdcdf4f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8467bdcdf4f) - Removing `dependencies` prop from PluginInjectionAPI and changing
+  signature of `NextEditorPlugin`.
+
+  Previously a `NextEditorPlugin` would be consumed as so:
+
+  ```ts
+  const plugin: NextEditorPlugin< ... > = (config, api) => {
+    // Can use api like so:
+    api.dependencies.core.actions.execute( ... )
+    return { ... }
+  }
+  ```
+
+  Now these have become named parameters like so and the `pluginInjectionAPI` is used
+  without the `dependencies` prop:
+
+  ```ts
+  const plugin: NextEditorPlugin< ... > = ({ config, api }) => {
+    // Can use api like so:
+    api.core.actions.execute( ... )
+    return { ... }
+  }
+  ```
+
+- Updated dependencies
+
 ## 0.4.1
 
 ### Patch Changes

package/dist/cjs/guideline.js

@@ -10,8 +10,8 @@ var _react = require("@emotion/react");
 var _guideline = require("@atlaskit/editor-common/guideline");
 var _colors = require("@atlaskit/theme/colors");
 var _positionStyles = require("./positionStyles");
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; } /** @jsx jsx */
+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; } /** @jsx jsx */
 var basicGuidelineStyles = (0, _react.css)({
   position: 'absolute',
   zIndex: 0,

package/dist/cjs/plugin.js

@@ -12,8 +12,8 @@ var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _editorSharedStyles = require("@atlaskit/editor-shared-styles");
 var _guidelineContainer = require("./guidelineContainer");
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; } /** @jsx jsx */
+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; } /** @jsx jsx */
 var guidelineStyles = (0, _react.css)({
   position: 'absolute',
   width: '100%',
@@ -92,7 +92,13 @@ var ContentComponent = function ContentComponent(_ref) {
     updateRect: updateRect
   }));
 };
-var guidelinePlugin = function guidelinePlugin(options, api) {
+/**
+ * Guideline plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+var guidelinePlugin = function guidelinePlugin(_ref4) {
+  var options = _ref4.config,
+    api = _ref4.api;
   return {
     name: 'guideline',
     getSharedState: function getSharedState(editorState) {
@@ -112,8 +118,8 @@ var guidelinePlugin = function guidelinePlugin(options, api) {
         }
       }];
     },
-    contentComponent: function contentComponent(_ref4) {
-      var editorView = _ref4.editorView;
+    contentComponent: function contentComponent(_ref5) {
+      var editorView = _ref5.editorView;
       return (0, _react.jsx)(ContentComponent, {
         editorView: editorView,
         options: options,

package/dist/es2019/plugin.js

@@ -91,7 +91,14 @@ const ContentComponent = ({
     updateRect: updateRect
   }));
 };
-export const guidelinePlugin = (options, api) => ({
+/**
+ * Guideline plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+export const guidelinePlugin = ({
+  config: options,
+  api
+}) => ({
   name: 'guideline',
   getSharedState(editorState) {
     if (!editorState) {

package/dist/esm/guideline.js

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+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; }
 /** @jsx jsx */
 import { css, jsx } from '@emotion/react';
 import { isVerticalPosition } from '@atlaskit/editor-common/guideline';

package/dist/esm/plugin.js

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+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; }
 /** @jsx jsx */
 import { css, jsx } from '@emotion/react';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
@@ -85,7 +85,13 @@ var ContentComponent = function ContentComponent(_ref) {
     updateRect: updateRect
   }));
 };
-export var guidelinePlugin = function guidelinePlugin(options, api) {
+/**
+ * Guideline plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+export var guidelinePlugin = function guidelinePlugin(_ref4) {
+  var options = _ref4.config,
+    api = _ref4.api;
   return {
     name: 'guideline',
     getSharedState: function getSharedState(editorState) {
@@ -105,8 +111,8 @@ export var guidelinePlugin = function guidelinePlugin(options, api) {
         }
       }];
     },
-    contentComponent: function contentComponent(_ref4) {
-      var editorView = _ref4.editorView;
+    contentComponent: function contentComponent(_ref5) {
+      var editorView = _ref5.editorView;
       return jsx(ContentComponent, {
         editorView: editorView,
         options: options,

package/dist/types/plugin.d.ts

@@ -9,4 +9,8 @@ export type GuidelinePlugin = NextEditorPlugin<'guideline', {
         displayGuideline: DisplayGuideline;
     };
 }>;
+/**
+ * Guideline plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const guidelinePlugin: GuidelinePlugin;

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

@@ -11,4 +11,8 @@ export type GuidelinePlugin = NextEditorPlugin<'guideline', {
         displayGuideline: DisplayGuideline;
     };
 }>;
+/**
+ * Guideline plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const guidelinePlugin: GuidelinePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-guideline",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "guideline plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -8,7 +8,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "atlassian": {
-    "team": "Editor Media Experience: Porygon",
+    "team": "Editor: Media Experience Porygon",
     "singleton": true,
     "releaseModel": "continuous"
   },
@@ -23,12 +23,12 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.52.0",
-    "@atlaskit/editor-plugin-width": "^0.1.0",
+    "@atlaskit/editor-common": "^74.55.0",
+    "@atlaskit/editor-plugin-width": "^0.2.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/editor-shared-styles": "^2.6.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.16.0",
+    "@atlaskit/tokens": "^1.18.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },

package/report.api.md

@@ -32,7 +32,7 @@ export type GuidelinePlugin = NextEditorPlugin<
   }
 >;
 
-// @public (undocumented)
+// @public
 export const guidelinePlugin: GuidelinePlugin;
 
 // (No @packageDocumentation comment for this package)

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,26 @@
+## API Report File for "@atlaskit/editor-plugin-guideline"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { DisplayGuideline } from '@atlaskit/editor-common/guideline';
+import { GuidelinePluginState } from '@atlaskit/editor-common/guideline';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
+
+// @public (undocumented)
+export type GuidelinePlugin = NextEditorPlugin<'guideline', {
+    dependencies: [WidthPlugin];
+    sharedState: GuidelinePluginState | null;
+    actions: {
+        displayGuideline: DisplayGuideline;
+    };
+}>;
+
+// @public
+export const guidelinePlugin: GuidelinePlugin;
+
+// (No @packageDocumentation comment for this package)
+
+```