@atlaskit/editor-plugin-grid 3.1.0 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-grid
 
+## 4.0.0
+
+### Patch Changes
+
+- [`0fda385059db0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0fda385059db0) -
+  PR to cleanup platform_editor_usesharedpluginstatewithselector for `collab-edit`,
+  `floating-toolbar`, `grid` and `guideline`
+- Updated dependencies
+
+## 3.1.1
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 3.1.0
 
 ### Minor Changes

package/dist/cjs/gridPlugin.js

@@ -129,28 +129,15 @@ var selector = function selector(states) {
     highlight: (_states$gridState3 = states.gridState) === null || _states$gridState3 === void 0 ? void 0 : _states$gridState3.highlight
   };
 };
-var useSharedState = (0, _hooks.sharedPluginStateHookMigratorFactory)(function (api) {
-  return (0, _hooks.useSharedPluginStateWithSelector)(api, ['width', 'grid'], selector);
-}, function (api) {
-  var _useSharedPluginState = (0, _hooks.useSharedPluginState)(api, ['width', 'grid']),
-    widthState = _useSharedPluginState.widthState,
-    gridState = _useSharedPluginState.gridState;
-  return {
-    width: widthState === null || widthState === void 0 ? void 0 : widthState.width,
-    visible: gridState === null || gridState === void 0 ? void 0 : gridState.visible,
-    gridType: gridState === null || gridState === void 0 ? void 0 : gridState.gridType,
-    highlight: gridState === null || gridState === void 0 ? void 0 : gridState.highlight
-  };
-});
 var ContentComponent = function ContentComponent(_ref4) {
   var api = _ref4.api,
     editorView = _ref4.editorView,
     options = _ref4.options;
-  var _useSharedState = useSharedState(api),
-    width = _useSharedState.width,
-    visible = _useSharedState.visible,
-    gridType = _useSharedState.gridType,
-    highlight = _useSharedState.highlight;
+  var _useSharedPluginState = (0, _hooks.useSharedPluginStateWithSelector)(api, ['width', 'grid'], selector),
+    width = _useSharedPluginState.width,
+    visible = _useSharedPluginState.visible,
+    gridType = _useSharedPluginState.gridType,
+    highlight = _useSharedPluginState.highlight;
   if (visible === undefined || !highlight) {
     return null;
   }

package/dist/es2019/gridPlugin.js

@@ -3,7 +3,7 @@ import React from 'react';
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { withTheme } from '@emotion/react';
 import classnames from 'classnames';
-import { useSharedPluginState, sharedPluginStateHookMigratorFactory, useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
+import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { akEditorBreakoutPadding, akEditorFullPageMaxWidth, breakoutWideScaleRatio } from '@atlaskit/editor-shared-styles';
@@ -122,20 +122,6 @@ const selector = states => {
     highlight: (_states$gridState3 = states.gridState) === null || _states$gridState3 === void 0 ? void 0 : _states$gridState3.highlight
   };
 };
-const useSharedState = sharedPluginStateHookMigratorFactory(api => {
-  return useSharedPluginStateWithSelector(api, ['width', 'grid'], selector);
-}, api => {
-  const {
-    widthState,
-    gridState
-  } = useSharedPluginState(api, ['width', 'grid']);
-  return {
-    width: widthState === null || widthState === void 0 ? void 0 : widthState.width,
-    visible: gridState === null || gridState === void 0 ? void 0 : gridState.visible,
-    gridType: gridState === null || gridState === void 0 ? void 0 : gridState.gridType,
-    highlight: gridState === null || gridState === void 0 ? void 0 : gridState.highlight
-  };
-});
 const ContentComponent = ({
   api,
   editorView,
@@ -146,7 +132,7 @@ const ContentComponent = ({
     visible,
     gridType,
     highlight
-  } = useSharedState(api);
+  } = useSharedPluginStateWithSelector(api, ['width', 'grid'], selector);
   if (visible === undefined || !highlight) {
     return null;
   }

package/dist/esm/gridPlugin.js

@@ -5,7 +5,7 @@ import React from 'react';
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { withTheme } from '@emotion/react';
 import classnames from 'classnames';
-import { useSharedPluginState, sharedPluginStateHookMigratorFactory, useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
+import { useSharedPluginStateWithSelector } from '@atlaskit/editor-common/hooks';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { akEditorBreakoutPadding, akEditorFullPageMaxWidth, breakoutWideScaleRatio } from '@atlaskit/editor-shared-styles';
@@ -122,28 +122,15 @@ var selector = function selector(states) {
     highlight: (_states$gridState3 = states.gridState) === null || _states$gridState3 === void 0 ? void 0 : _states$gridState3.highlight
   };
 };
-var useSharedState = sharedPluginStateHookMigratorFactory(function (api) {
-  return useSharedPluginStateWithSelector(api, ['width', 'grid'], selector);
-}, function (api) {
-  var _useSharedPluginState = useSharedPluginState(api, ['width', 'grid']),
-    widthState = _useSharedPluginState.widthState,
-    gridState = _useSharedPluginState.gridState;
-  return {
-    width: widthState === null || widthState === void 0 ? void 0 : widthState.width,
-    visible: gridState === null || gridState === void 0 ? void 0 : gridState.visible,
-    gridType: gridState === null || gridState === void 0 ? void 0 : gridState.gridType,
-    highlight: gridState === null || gridState === void 0 ? void 0 : gridState.highlight
-  };
-});
 var ContentComponent = function ContentComponent(_ref4) {
   var api = _ref4.api,
     editorView = _ref4.editorView,
     options = _ref4.options;
-  var _useSharedState = useSharedState(api),
-    width = _useSharedState.width,
-    visible = _useSharedState.visible,
-    gridType = _useSharedState.gridType,
-    highlight = _useSharedState.highlight;
+  var _useSharedPluginState = useSharedPluginStateWithSelector(api, ['width', 'grid'], selector),
+    width = _useSharedPluginState.width,
+    visible = _useSharedPluginState.visible,
+    gridType = _useSharedPluginState.gridType,
+    highlight = _useSharedPluginState.highlight;
   if (visible === undefined || !highlight) {
     return null;
   }

package/dist/types/gridPluginType.d.ts

@@ -8,8 +8,8 @@ export type GridPluginActions = {
     displayGrid: CreateDisplayGrid;
 };
 export type GridPlugin = NextEditorPlugin<'grid', {
-    pluginConfiguration: GridPluginConfiguration;
+    actions: GridPluginActions;
     dependencies: GridPluginDependencies;
+    pluginConfiguration: GridPluginConfiguration;
     sharedState: GridPluginSharedState;
-    actions: GridPluginActions;
 }>;

package/dist/types/types/index.d.ts

@@ -2,9 +2,9 @@ import type { GridType } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 export type Highlights = Array<'wide' | 'full-width' | number>;
 export type GridPluginState = {
-    visible: boolean;
     gridType?: GridType;
     highlight: Highlights;
+    visible: boolean;
 };
 type Required<T> = {
     [P in keyof T]-?: T[P];

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

@@ -10,8 +10,8 @@ export type GridPluginActions = {
     displayGrid: CreateDisplayGrid;
 };
 export type GridPlugin = NextEditorPlugin<'grid', {
-    pluginConfiguration: GridPluginConfiguration;
+    actions: GridPluginActions;
     dependencies: GridPluginDependencies;
+    pluginConfiguration: GridPluginConfiguration;
     sharedState: GridPluginSharedState;
-    actions: GridPluginActions;
 }>;

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

@@ -2,9 +2,9 @@ import type { GridType } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 export type Highlights = Array<'wide' | 'full-width' | number>;
 export type GridPluginState = {
-    visible: boolean;
     gridType?: GridType;
     highlight: Highlights;
+    visible: boolean;
 };
 type Required<T> = {
     [P in keyof T]-?: T[P];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-grid",
-	"version": "3.1.0",
+	"version": "4.0.0",
 	"description": "Grid plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -20,25 +20,21 @@
 		"*.compiled.css"
 	],
 	"atlaskit:src": "src/index.ts",
-	"af:exports": {
-		".": "./src/index.ts"
-	},
 	"dependencies": {
-		"@atlaskit/editor-plugin-width": "^4.0.0",
+		"@atlaskit/editor-plugin-width": "^5.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/editor-shared-styles": "^3.5.0",
+		"@atlaskit/editor-shared-styles": "^3.6.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
 		"classnames": "^2.2.5"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.9.0",
+		"@atlaskit/editor-common": "^108.0.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
 	"devDependencies": {
 		"@testing-library/react": "^13.4.0",
-		"typescript": "~5.4.2",
 		"wait-for-expect": "^1.2.0"
 	},
 	"techstack": {