@atlaskit/editor-common 74.7.1 → 74.7.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-common
 
+## 74.7.2
+
+### Patch Changes
+
+- [`b9c2562b357`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b9c2562b357) - Mark WithPluginState as deprecated.
+
 ## 74.7.1
 
 ### Patch Changes

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "74.7.1";
+var packageVersion = "74.7.2";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ var _templateObject, _templateObject2, _templateObject3;
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } } /** @jsx jsx */
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "74.7.1";
+var packageVersion = "74.7.2";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.7.1",
+	"version": "74.7.2",
 	"sideEffects": false
 }

package/dist/cjs/with-plugin-state/index.js

@@ -30,20 +30,40 @@ var DEFAULT_SLOW_THRESHOLD = 4;
 // - EditorAction: packages/editor/editor-core/src/actions/index.ts
 // - EditorSharedConfig: packages/editor/editor-core/src/labs/next/internal/context/shared-config.tsx
 /**
- * Wraps component in a high order component that watches state changes of given plugins
- * and passes those states to the wrapped component.
+ * @private
+ * @deprecated
  *
- * Example:
+ * Using this component is deprecated. It should be replaced with `useSharedPluginState`.
+ * This requires having access to the injection API from the plugin itself.
+ *
+ * An example of the refactor with the new hook (using hyperlink as an example) is:
+ *
+ * Before:
+ * ```ts
  * <WithPluginState
- *   eventDispatcher={eventDispatcher}
  *   editorView={editorView}
  *   plugins={{
- *     hyperlink: hyperlinkPluginKey
+ *     hyperlinkState: hyperlinkPluginKey
  *   }}
- *   render={renderComponent}
+ *   render={({ hyperlinkState }) =>
+ *     renderComponent({ hyperlinkState })
+ *   }
  * />
+ * ```
+ *
+ * After:
+ * ```ts
+ * import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+ * import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+ *
+ * function ComponentWithState(
+ *   api: ExtractInjectionAPI<typeof hyperlinkPlugin> | undefined
+ * ) {
+ *   const { hyperlinkState } = useSharedPluginState(api, ['hyperlink']);
+ *   return renderComponent({ hyperlinkState })
+ * }
+ * ```
  *
- * renderComponent: ({ hyperlink }) => React.Component;
  */
 var WithPluginState = /*#__PURE__*/function (_React$Component) {
   (0, _inherits2.default)(WithPluginState, _React$Component);

package/dist/es2019/monitoring/error.js

@@ -1,6 +1,6 @@
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "74.7.1";
+const packageVersion = "74.7.2";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/es2019/ui/DropList/index.js

@@ -8,7 +8,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "74.7.1";
+const packageVersion = "74.7.2";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.7.1",
+	"version": "74.7.2",
 	"sideEffects": false
 }

package/dist/es2019/with-plugin-state/index.js

@@ -13,20 +13,40 @@ const DEFAULT_SLOW_THRESHOLD = 4;
 // - EditorAction: packages/editor/editor-core/src/actions/index.ts
 // - EditorSharedConfig: packages/editor/editor-core/src/labs/next/internal/context/shared-config.tsx
 /**
- * Wraps component in a high order component that watches state changes of given plugins
- * and passes those states to the wrapped component.
+ * @private
+ * @deprecated
  *
- * Example:
+ * Using this component is deprecated. It should be replaced with `useSharedPluginState`.
+ * This requires having access to the injection API from the plugin itself.
+ *
+ * An example of the refactor with the new hook (using hyperlink as an example) is:
+ *
+ * Before:
+ * ```ts
  * <WithPluginState
- *   eventDispatcher={eventDispatcher}
  *   editorView={editorView}
  *   plugins={{
- *     hyperlink: hyperlinkPluginKey
+ *     hyperlinkState: hyperlinkPluginKey
  *   }}
- *   render={renderComponent}
+ *   render={({ hyperlinkState }) =>
+ *     renderComponent({ hyperlinkState })
+ *   }
  * />
+ * ```
+ *
+ * After:
+ * ```ts
+ * import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+ * import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+ *
+ * function ComponentWithState(
+ *   api: ExtractInjectionAPI<typeof hyperlinkPlugin> | undefined
+ * ) {
+ *   const { hyperlinkState } = useSharedPluginState(api, ['hyperlink']);
+ *   return renderComponent({ hyperlinkState })
+ * }
+ * ```
  *
- * renderComponent: ({ hyperlink }) => React.Component;
  */
 class WithPluginState extends React.Component {
   constructor(...args) {

package/dist/esm/monitoring/error.js

@@ -6,7 +6,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 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; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "74.7.1";
+var packageVersion = "74.7.2";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/esm/ui/DropList/index.js

@@ -18,7 +18,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "74.7.1";
+var packageVersion = "74.7.2";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.7.1",
+	"version": "74.7.2",
 	"sideEffects": false
 }

package/dist/esm/with-plugin-state/index.js

@@ -23,20 +23,40 @@ var DEFAULT_SLOW_THRESHOLD = 4;
 // - EditorAction: packages/editor/editor-core/src/actions/index.ts
 // - EditorSharedConfig: packages/editor/editor-core/src/labs/next/internal/context/shared-config.tsx
 /**
- * Wraps component in a high order component that watches state changes of given plugins
- * and passes those states to the wrapped component.
+ * @private
+ * @deprecated
  *
- * Example:
+ * Using this component is deprecated. It should be replaced with `useSharedPluginState`.
+ * This requires having access to the injection API from the plugin itself.
+ *
+ * An example of the refactor with the new hook (using hyperlink as an example) is:
+ *
+ * Before:
+ * ```ts
  * <WithPluginState
- *   eventDispatcher={eventDispatcher}
  *   editorView={editorView}
  *   plugins={{
- *     hyperlink: hyperlinkPluginKey
+ *     hyperlinkState: hyperlinkPluginKey
  *   }}
- *   render={renderComponent}
+ *   render={({ hyperlinkState }) =>
+ *     renderComponent({ hyperlinkState })
+ *   }
  * />
+ * ```
+ *
+ * After:
+ * ```ts
+ * import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+ * import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+ *
+ * function ComponentWithState(
+ *   api: ExtractInjectionAPI<typeof hyperlinkPlugin> | undefined
+ * ) {
+ *   const { hyperlinkState } = useSharedPluginState(api, ['hyperlink']);
+ *   return renderComponent({ hyperlinkState })
+ * }
+ * ```
  *
- * renderComponent: ({ hyperlink }) => React.Component;
  */
 var WithPluginState = /*#__PURE__*/function (_React$Component) {
   _inherits(WithPluginState, _React$Component);

package/dist/types/with-plugin-state/index.d.ts

@@ -38,20 +38,40 @@ export interface Props<P extends NamedPluginKeys> {
     render: (pluginState: NamedPluginStates<P>) => React.ReactElement | null;
 }
 /**
- * Wraps component in a high order component that watches state changes of given plugins
- * and passes those states to the wrapped component.
+ * @private
+ * @deprecated
  *
- * Example:
+ * Using this component is deprecated. It should be replaced with `useSharedPluginState`.
+ * This requires having access to the injection API from the plugin itself.
+ *
+ * An example of the refactor with the new hook (using hyperlink as an example) is:
+ *
+ * Before:
+ * ```ts
  * <WithPluginState
- *   eventDispatcher={eventDispatcher}
  *   editorView={editorView}
  *   plugins={{
- *     hyperlink: hyperlinkPluginKey
+ *     hyperlinkState: hyperlinkPluginKey
  *   }}
- *   render={renderComponent}
+ *   render={({ hyperlinkState }) =>
+ *     renderComponent({ hyperlinkState })
+ *   }
  * />
+ * ```
+ *
+ * After:
+ * ```ts
+ * import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+ * import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+ *
+ * function ComponentWithState(
+ *   api: ExtractInjectionAPI<typeof hyperlinkPlugin> | undefined
+ * ) {
+ *   const { hyperlinkState } = useSharedPluginState(api, ['hyperlink']);
+ *   return renderComponent({ hyperlinkState })
+ * }
+ * ```
  *
- * renderComponent: ({ hyperlink }) => React.Component;
  */
 declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
     static displayName: string;

package/dist/types-ts4.5/with-plugin-state/index.d.ts

@@ -38,20 +38,40 @@ export interface Props<P extends NamedPluginKeys> {
     render: (pluginState: NamedPluginStates<P>) => React.ReactElement | null;
 }
 /**
- * Wraps component in a high order component that watches state changes of given plugins
- * and passes those states to the wrapped component.
+ * @private
+ * @deprecated
  *
- * Example:
+ * Using this component is deprecated. It should be replaced with `useSharedPluginState`.
+ * This requires having access to the injection API from the plugin itself.
+ *
+ * An example of the refactor with the new hook (using hyperlink as an example) is:
+ *
+ * Before:
+ * ```ts
  * <WithPluginState
- *   eventDispatcher={eventDispatcher}
  *   editorView={editorView}
  *   plugins={{
- *     hyperlink: hyperlinkPluginKey
+ *     hyperlinkState: hyperlinkPluginKey
  *   }}
- *   render={renderComponent}
+ *   render={({ hyperlinkState }) =>
+ *     renderComponent({ hyperlinkState })
+ *   }
  * />
+ * ```
+ *
+ * After:
+ * ```ts
+ * import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
+ * import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+ *
+ * function ComponentWithState(
+ *   api: ExtractInjectionAPI<typeof hyperlinkPlugin> | undefined
+ * ) {
+ *   const { hyperlinkState } = useSharedPluginState(api, ['hyperlink']);
+ *   return renderComponent({ hyperlinkState })
+ * }
+ * ```
  *
- * renderComponent: ({ hyperlink }) => React.Component;
  */
 declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
     static displayName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "74.7.1",
+  "version": "74.7.2",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -87,7 +87,7 @@
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/in-product-testing": "^0.2.0",
     "@atlaskit/media-card": "^76.0.0",
-    "@atlaskit/media-client": "^23.0.0",
+    "@atlaskit/media-client": "^23.1.0",
     "@atlaskit/media-picker": "^66.0.0",
     "@atlaskit/mention": "^22.1.0",
     "@atlaskit/menu": "^1.7.0",