@atlaskit/editor-plugin-decorations 0.1.5 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-decorations
 
+## 0.2.0
+
+### Minor Changes
+
+- [`ad3c5c21079`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ad3c5c21079) - Updating all plugins with minor version to correct issue with semver.
+
 ## 0.1.5
 
 ### Patch Changes

package/README.md

@@ -1,7 +1,30 @@
-# EditorPluginDecorations
+# Editor plugin decorations
 
 Decorations plugin for @atlaskit/editor-core
 
+**Note:** This component is designed for internal Atlassian development.
+External contributors will be able to use this component but will not be able to submit issues.
+
+## Install
+---
+- **Install** - *yarn add @atlaskit/editor-plugin-decorations*
+- **npm** - [@atlaskit/editor-plugin-decorations](https://www.npmjs.com/package/@atlaskit/editor-plugin-decorations)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-decorations)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-decorations/dist/)
+
 ## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-decorations is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
+Direct use of this component is not supported.
+
+Please see [Atlaskit - Editor plugin decorations](https://atlaskit.atlassian.com/packages/editor/editor-plugin-decorations) for documentation and examples for this package.
 
-`import { decorationsPlugin } from '@atlaskit/editor-plugin-decorations';`
+## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://developer.atlassian.com/cloud/framework/atlassian-frontend/#license) for more licensing information.

package/dist/cjs/plugin.js

@@ -8,6 +8,10 @@ exports.decorationsPlugin = void 0;
 var _pmPlugin = _interopRequireWildcard(require("./pm-plugin"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 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; }
+/**
+ * Decorations plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 var decorationsPlugin = function decorationsPlugin() {
   return {
     name: 'decorations',

package/dist/es2019/plugin.js

@@ -1,4 +1,8 @@
 import decorationPlugin, { decorationStateKey, hoverDecoration, removeDecoration } from './pm-plugin';
+/**
+ * Decorations plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export const decorationsPlugin = () => ({
   name: 'decorations',
   pmPlugins() {

package/dist/esm/plugin.js

@@ -1,4 +1,8 @@
 import decorationPlugin, { decorationStateKey, hoverDecoration, removeDecoration } from './pm-plugin';
+/**
+ * Decorations plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export var decorationsPlugin = function decorationsPlugin() {
   return {
     name: 'decorations',

package/dist/types/plugin.d.ts

@@ -8,4 +8,8 @@ export type DecorationsPlugin = NextEditorPlugin<'decorations', {
         removeDecoration: typeof removeDecoration;
     };
 }>;
+/**
+ * Decorations plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const decorationsPlugin: DecorationsPlugin;

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

@@ -8,4 +8,8 @@ export type DecorationsPlugin = NextEditorPlugin<'decorations', {
         removeDecoration: typeof removeDecoration;
     };
 }>;
+/**
+ * Decorations plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const decorationsPlugin: DecorationsPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-decorations",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "Decorations 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",
+    "team": "Editor: Lego",
     "singleton": true,
     "releaseModel": "continuous"
   },
@@ -23,7 +23,7 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.53.0",
+    "@atlaskit/editor-common": "^74.55.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@babel/runtime": "^7.0.0"
   },

package/report.api.md

@@ -32,7 +32,7 @@ export type DecorationsPlugin = NextEditorPlugin<
   }
 >;
 
-// @public (undocumented)
+// @public
 export const decorationsPlugin: DecorationsPlugin;
 
 // @public (undocumented)

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

@@ -18,7 +18,7 @@ export type DecorationsPlugin = NextEditorPlugin<'decorations', {
     };
 }>;
 
-// @public (undocumented)
+// @public
 export const decorationsPlugin: DecorationsPlugin;
 
 // @public (undocumented)