@atlaskit/editor-plugin-decorations 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,41 @@
1
1
  # @atlaskit/editor-plugin-decorations
2
2
 
3
+ ## 0.1.5
4
+
5
+ ### Patch Changes
6
+
7
+ - [`8467bdcdf4f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8467bdcdf4f) - Removing `dependencies` prop from PluginInjectionAPI and changing
8
+ signature of `NextEditorPlugin`.
9
+
10
+ Previously a `NextEditorPlugin` would be consumed as so:
11
+
12
+ ```ts
13
+ const plugin: NextEditorPlugin< ... > = (config, api) => {
14
+ // Can use api like so:
15
+ api.dependencies.core.actions.execute( ... )
16
+ return { ... }
17
+ }
18
+ ```
19
+
20
+ Now these have become named parameters like so and the `pluginInjectionAPI` is used
21
+ without the `dependencies` prop:
22
+
23
+ ```ts
24
+ const plugin: NextEditorPlugin< ... > = ({ config, api }) => {
25
+ // Can use api like so:
26
+ api.core.actions.execute( ... )
27
+ return { ... }
28
+ }
29
+ ```
30
+
31
+ - Updated dependencies
32
+
33
+ ## 0.1.4
34
+
35
+ ### Patch Changes
36
+
37
+ - [`24e27147cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24e27147cbd) - Added atlaskit docs to all existing plugins.
38
+
3
39
  ## 0.1.3
4
40
 
5
41
  ### Patch Changes
@@ -1,2 +1,3 @@
1
1
  export { decorationsPlugin } from './plugin';
2
+ export type { DecorationsPlugin } from './plugin';
2
3
  export type { HoverDecorationHandler, DecorationState } from './pm-plugin';
@@ -1,9 +1,11 @@
1
1
  import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
2
- import { DecorationState, HoverDecorationHandler, removeDecoration } from './pm-plugin';
3
- export declare const decorationsPlugin: NextEditorPlugin<'decorations', {
2
+ import type { DecorationState, HoverDecorationHandler } from './pm-plugin';
3
+ import { removeDecoration } from './pm-plugin';
4
+ export type DecorationsPlugin = NextEditorPlugin<'decorations', {
4
5
  sharedState: DecorationState;
5
6
  actions: {
6
7
  hoverDecoration: HoverDecorationHandler;
7
8
  removeDecoration: typeof removeDecoration;
8
9
  };
9
10
  }>;
11
+ export declare const decorationsPlugin: DecorationsPlugin;
@@ -1,2 +1,3 @@
1
1
  export { decorationsPlugin } from './plugin';
2
+ export type { DecorationsPlugin } from './plugin';
2
3
  export type { HoverDecorationHandler, DecorationState } from './pm-plugin';
@@ -1,9 +1,11 @@
1
1
  import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
2
- import { DecorationState, HoverDecorationHandler, removeDecoration } from './pm-plugin';
3
- export declare const decorationsPlugin: NextEditorPlugin<'decorations', {
2
+ import type { DecorationState, HoverDecorationHandler } from './pm-plugin';
3
+ import { removeDecoration } from './pm-plugin';
4
+ export type DecorationsPlugin = NextEditorPlugin<'decorations', {
4
5
  sharedState: DecorationState;
5
6
  actions: {
6
7
  hoverDecoration: HoverDecorationHandler;
7
8
  removeDecoration: typeof removeDecoration;
8
9
  };
9
10
  }>;
11
+ export declare const decorationsPlugin: DecorationsPlugin;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-decorations",
3
- "version": "0.1.3",
3
+ "version": "0.1.5",
4
4
  "description": "Decorations plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -23,7 +23,7 @@
23
23
  ".": "./src/index.ts"
24
24
  },
25
25
  "dependencies": {
26
- "@atlaskit/editor-common": "^74.42.0",
26
+ "@atlaskit/editor-common": "^74.53.0",
27
27
  "@atlaskit/editor-prosemirror": "1.1.0",
28
28
  "@babel/runtime": "^7.0.0"
29
29
  },
@@ -31,7 +31,6 @@
31
31
  "react": "^16.8.0"
32
32
  },
33
33
  "devDependencies": {
34
- "@atlaskit/editor-test-helpers": "^18.10.0",
35
34
  "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
36
35
  "@testing-library/react": "^12.1.5",
37
36
  "react-dom": "^16.8.0",
package/report.api.md CHANGED
@@ -21,7 +21,7 @@ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
21
21
  import { NodeType } from '@atlaskit/editor-prosemirror/model';
22
22
 
23
23
  // @public (undocumented)
24
- export const decorationsPlugin: NextEditorPlugin<
24
+ export type DecorationsPlugin = NextEditorPlugin<
25
25
  'decorations',
26
26
  {
27
27
  sharedState: DecorationState;
@@ -32,6 +32,9 @@ export const decorationsPlugin: NextEditorPlugin<
32
32
  }
33
33
  >;
34
34
 
35
+ // @public (undocumented)
36
+ export const decorationsPlugin: DecorationsPlugin;
37
+
35
38
  // @public (undocumented)
36
39
  export type DecorationState = {
37
40
  decoration?: Decoration;
@@ -10,7 +10,7 @@ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
10
10
  import { NodeType } from '@atlaskit/editor-prosemirror/model';
11
11
 
12
12
  // @public (undocumented)
13
- export const decorationsPlugin: NextEditorPlugin<'decorations', {
13
+ export type DecorationsPlugin = NextEditorPlugin<'decorations', {
14
14
  sharedState: DecorationState;
15
15
  actions: {
16
16
  hoverDecoration: HoverDecorationHandler;
@@ -18,6 +18,9 @@ export const decorationsPlugin: NextEditorPlugin<'decorations', {
18
18
  };
19
19
  }>;
20
20
 
21
+ // @public (undocumented)
22
+ export const decorationsPlugin: DecorationsPlugin;
23
+
21
24
  // @public (undocumented)
22
25
  export type DecorationState = {
23
26
  decoration?: Decoration;
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-decorations",
3
- "version": "0.1.3",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-decorations",
3
- "version": "0.1.3",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-decorations",
3
- "version": "0.1.3",
4
- "sideEffects": false
5
- }