@atlaskit/editor-plugin-grid 0.1.5 → 0.1.7

package/CHANGELOG.md

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

package/dist/cjs/plugin.js

@@ -143,7 +143,9 @@ var gridPMPlugin = new _safePlugin.SafePlugin({
     }
   }
 });
-var gridPlugin = function gridPlugin(options, api) {
+var gridPlugin = function gridPlugin(_ref5) {
+  var options = _ref5.config,
+    api = _ref5.api;
   return {
     name: 'grid',
     getSharedState: function getSharedState(editorState) {
@@ -163,8 +165,8 @@ var gridPlugin = function gridPlugin(options, api) {
         }
       }];
     },
-    contentComponent: function contentComponent(_ref5) {
-      var editorView = _ref5.editorView;
+    contentComponent: function contentComponent(_ref6) {
+      var editorView = _ref6.editorView;
       return /*#__PURE__*/_react.default.createElement(ContentComponent, {
         editorView: editorView,
         options: options,

package/dist/es2019/plugin.js

@@ -134,7 +134,10 @@ const gridPMPlugin = new SafePlugin({
     }
   }
 });
-export const gridPlugin = (options, api) => {
+export const gridPlugin = ({
+  config: options,
+  api
+}) => {
   return {
     name: 'grid',
     getSharedState(editorState) {

package/dist/esm/plugin.js

@@ -135,7 +135,9 @@ var gridPMPlugin = new SafePlugin({
     }
   }
 });
-export var gridPlugin = function gridPlugin(options, api) {
+export var gridPlugin = function gridPlugin(_ref5) {
+  var options = _ref5.config,
+    api = _ref5.api;
   return {
     name: 'grid',
     getSharedState: function getSharedState(editorState) {
@@ -155,8 +157,8 @@ export var gridPlugin = function gridPlugin(options, api) {
         }
       }];
     },
-    contentComponent: function contentComponent(_ref5) {
-      var editorView = _ref5.editorView;
+    contentComponent: function contentComponent(_ref6) {
+      var editorView = _ref6.editorView;
       return /*#__PURE__*/React.createElement(ContentComponent, {
         editorView: editorView,
         options: options,

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export { gridPlugin } from './plugin';
+export type { GridPlugin } from './plugin';
 export type { Highlights } from './types';

package/dist/types/plugin.d.ts

@@ -1,6 +1,6 @@
-import { NextEditorPlugin } from '@atlaskit/editor-common/types';
-import type { widthPlugin } from '@atlaskit/editor-plugin-width';
-import { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { GridPluginState } from './types';
 export declare const GRID_SIZE = 12;
 type Required<T> = {
@@ -11,12 +11,13 @@ type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
 export interface GridPluginOptions {
     shouldCalcBreakoutGridLines?: boolean;
 }
-export declare const gridPlugin: NextEditorPlugin<'grid', {
+export type GridPlugin = NextEditorPlugin<'grid', {
     pluginConfiguration: GridPluginOptions | undefined;
-    dependencies: [typeof widthPlugin];
+    dependencies: [WidthPlugin];
     sharedState: GridPluginState | null;
     actions: {
         displayGrid: CreateDisplayGrid;
     };
 }>;
+export declare const gridPlugin: GridPlugin;
 export {};

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

@@ -1,2 +1,3 @@
 export { gridPlugin } from './plugin';
+export type { GridPlugin } from './plugin';
 export type { Highlights } from './types';

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

@@ -1,6 +1,6 @@
-import { NextEditorPlugin } from '@atlaskit/editor-common/types';
-import type { widthPlugin } from '@atlaskit/editor-plugin-width';
-import { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { GridPluginState } from './types';
 export declare const GRID_SIZE = 12;
 type Required<T> = {
@@ -11,14 +11,15 @@ type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
 export interface GridPluginOptions {
     shouldCalcBreakoutGridLines?: boolean;
 }
-export declare const gridPlugin: NextEditorPlugin<'grid', {
+export type GridPlugin = NextEditorPlugin<'grid', {
     pluginConfiguration: GridPluginOptions | undefined;
     dependencies: [
-        typeof widthPlugin
+        WidthPlugin
     ];
     sharedState: GridPluginState | null;
     actions: {
         displayGrid: CreateDisplayGrid;
     };
 }>;
+export declare const gridPlugin: GridPlugin;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-grid",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Grid plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -23,7 +23,7 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.42.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",
@@ -35,7 +35,6 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^18.10.0",
     "@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",

package/report.api.md

@@ -15,10 +15,10 @@
 <!--SECTION START: Main Entry Types-->
 
 ```ts
-import { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { GridType } from '@atlaskit/editor-common/types';
-import { NextEditorPlugin } from '@atlaskit/editor-common/types';
-import type { widthPlugin } from '@atlaskit/editor-plugin-width';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 
 // @public (undocumented)
 type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
@@ -27,11 +27,11 @@ type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
 type DisplayGrid = (props: Required_2<GridPluginState>) => boolean;
 
 // @public (undocumented)
-export const gridPlugin: NextEditorPlugin<
+export type GridPlugin = NextEditorPlugin<
   'grid',
   {
     pluginConfiguration: GridPluginOptions | undefined;
-    dependencies: [typeof widthPlugin];
+    dependencies: [WidthPlugin];
     sharedState: GridPluginState | null;
     actions: {
       displayGrid: CreateDisplayGrid;
@@ -39,6 +39,9 @@ export const gridPlugin: NextEditorPlugin<
   }
 >;
 
+// @public (undocumented)
+export const gridPlugin: GridPlugin;
+
 // @public (undocumented)
 interface GridPluginOptions {
   // (undocumented)

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

@@ -4,10 +4,10 @@
 
 ```ts
 
-import { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { GridType } from '@atlaskit/editor-common/types';
-import { NextEditorPlugin } from '@atlaskit/editor-common/types';
-import type { widthPlugin } from '@atlaskit/editor-plugin-width';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 
 // @public (undocumented)
 type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
@@ -16,15 +16,18 @@ type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
 type DisplayGrid = (props: Required_2<GridPluginState>) => boolean;
 
 // @public (undocumented)
-export const gridPlugin: NextEditorPlugin<'grid', {
+export type GridPlugin = NextEditorPlugin<'grid', {
     pluginConfiguration: GridPluginOptions | undefined;
-    dependencies: [typeof widthPlugin];
+    dependencies: [WidthPlugin];
     sharedState: GridPluginState | null;
     actions: {
         displayGrid: CreateDisplayGrid;
     };
 }>;
 
+// @public (undocumented)
+export const gridPlugin: GridPlugin;
+
 // @public (undocumented)
 interface GridPluginOptions {
     // (undocumented)

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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