@atlaskit/editor-plugin-guideline 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @atlaskit/editor-plugin-guideline
 
+## 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
+
+- [`24e27147cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24e27147cbd) - Added atlaskit docs to all existing plugins.
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/cjs/plugin.js

@@ -92,7 +92,9 @@ var ContentComponent = function ContentComponent(_ref) {
     updateRect: updateRect
   }));
 };
-var guidelinePlugin = function guidelinePlugin(options, api) {
+var guidelinePlugin = function guidelinePlugin(_ref4) {
+  var options = _ref4.config,
+    api = _ref4.api;
   return {
     name: 'guideline',
     getSharedState: function getSharedState(editorState) {
@@ -112,8 +114,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,10 @@ const ContentComponent = ({
     updateRect: updateRect
   }));
 };
-export const guidelinePlugin = (options, api) => ({
+export const guidelinePlugin = ({
+  config: options,
+  api
+}) => ({
   name: 'guideline',
   getSharedState(editorState) {
     if (!editorState) {

package/dist/esm/plugin.js

@@ -85,7 +85,9 @@ var ContentComponent = function ContentComponent(_ref) {
     updateRect: updateRect
   }));
 };
-export var guidelinePlugin = function guidelinePlugin(options, api) {
+export var guidelinePlugin = function guidelinePlugin(_ref4) {
+  var options = _ref4.config,
+    api = _ref4.api;
   return {
     name: 'guideline',
     getSharedState: function getSharedState(editorState) {
@@ -105,8 +107,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/index.d.ts

@@ -1 +1,2 @@
 export { guidelinePlugin } from './plugin';
+export type { GuidelinePlugin } from './plugin';

package/dist/types/plugin.d.ts

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

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

@@ -1 +1,2 @@
 export { guidelinePlugin } from './plugin';
+export type { GuidelinePlugin } from './plugin';

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-guideline",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "guideline plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -23,12 +23,12 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.51.0",
+    "@atlaskit/editor-common": "^74.53.0",
     "@atlaskit/editor-plugin-width": "^0.1.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/editor-shared-styles": "^2.6.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.15.0",
+    "@atlaskit/tokens": "^1.17.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },

package/report.api.md

@@ -18,13 +18,13 @@
 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';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 
 // @public (undocumented)
-export const guidelinePlugin: NextEditorPlugin<
+export type GuidelinePlugin = NextEditorPlugin<
   'guideline',
   {
-    dependencies: [typeof widthPlugin];
+    dependencies: [WidthPlugin];
     sharedState: GuidelinePluginState | null;
     actions: {
       displayGuideline: DisplayGuideline;
@@ -32,6 +32,9 @@ export const guidelinePlugin: NextEditorPlugin<
   }
 >;
 
+// @public (undocumented)
+export const guidelinePlugin: GuidelinePlugin;
+
 // (No @packageDocumentation comment for this package)
 ```
 

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

@@ -7,17 +7,20 @@
 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';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 
 // @public (undocumented)
-export const guidelinePlugin: NextEditorPlugin<'guideline', {
-    dependencies: [typeof widthPlugin];
+export type GuidelinePlugin = NextEditorPlugin<'guideline', {
+    dependencies: [WidthPlugin];
     sharedState: GuidelinePluginState | null;
     actions: {
         displayGuideline: DisplayGuideline;
     };
 }>;
 
+// @public (undocumented)
+export const guidelinePlugin: GuidelinePlugin;
+
 // (No @packageDocumentation comment for this package)
 
 ```