@atlaskit/editor-plugin-hyperlink 0.3.0 → 0.3.2

package/.eslintrc.js

@@ -1,7 +1,5 @@
 module.exports = {
   rules: {
-    '@typescript-eslint/consistent-type-imports': 'warn',
-    'no-duplicate-imports': 'off',
     '@typescript-eslint/no-duplicate-imports': 'error',
   },
 };

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-hyperlink
 
+## 0.3.2
+
+### Patch Changes
+
+- [`24fc3925d73`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24fc3925d73) - Add a new hook called `usePreset` accesed via `@atlaskit/editor-core/use-preset`. This hook can be used to safely access state and commands from outside the editor using `EditorContext`.
+- Updated dependencies
+
+## 0.3.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/cjs/pm-plugins/keymap.js

@@ -16,7 +16,7 @@ function createKeymapPlugin() {
   var skipAnalytics = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
   var editorAnalyticsApi = arguments.length > 1 ? arguments[1] : undefined;
   var list = {};
-  (0, _keymaps.bindKeymapWithPluginCommand)(_keymaps.addLink.common, (0, _commands.showLinkToolbar)(_analytics.INPUT_METHOD.SHORTCUT, editorAnalyticsApi), list);
+  (0, _keymaps.bindKeymapWithEditorCommand)(_keymaps.addLink.common, (0, _commands.showLinkToolbar)(_analytics.INPUT_METHOD.SHORTCUT, editorAnalyticsApi), list);
   (0, _keymaps.bindKeymapWithCommand)(_keymaps.enter.common, mayConvertLastWordToHyperlink(skipAnalytics, editorAnalyticsApi), list);
   (0, _keymaps.bindKeymapWithCommand)(_keymaps.insertNewLine.common, mayConvertLastWordToHyperlink(skipAnalytics, editorAnalyticsApi), list);
   (0, _keymaps.bindKeymapWithCommand)(_keymaps.escape.common, function (state, dispatch, view) {

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-plugin-hyperlink",
-	"version": "0.3.0",
+	"version": "0.3.2",
 	"sideEffects": false
 }

package/dist/es2019/pm-plugins/keymap.js

@@ -1,13 +1,13 @@
 import { getLinkMatch } from '@atlaskit/adf-schema';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import { addLink, bindKeymapWithCommand, bindKeymapWithPluginCommand, enter, escape, insertNewLine } from '@atlaskit/editor-common/keymaps';
+import { addLink, bindKeymapWithCommand, bindKeymapWithEditorCommand, enter, escape, insertNewLine } from '@atlaskit/editor-common/keymaps';
 import { findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches } from '@atlaskit/editor-common/utils';
 import { keymap } from '@atlaskit/editor-prosemirror/keymap';
 import { hideLinkToolbar, showLinkToolbar } from '../commands';
 import { stateKey } from '../pm-plugins/main';
 export function createKeymapPlugin(skipAnalytics = false, editorAnalyticsApi) {
   const list = {};
-  bindKeymapWithPluginCommand(addLink.common, showLinkToolbar(INPUT_METHOD.SHORTCUT, editorAnalyticsApi), list);
+  bindKeymapWithEditorCommand(addLink.common, showLinkToolbar(INPUT_METHOD.SHORTCUT, editorAnalyticsApi), list);
   bindKeymapWithCommand(enter.common, mayConvertLastWordToHyperlink(skipAnalytics, editorAnalyticsApi), list);
   bindKeymapWithCommand(insertNewLine.common, mayConvertLastWordToHyperlink(skipAnalytics, editorAnalyticsApi), list);
   bindKeymapWithCommand(escape.common, (state, dispatch, view) => {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-plugin-hyperlink",
-	"version": "0.3.0",
+	"version": "0.3.2",
 	"sideEffects": false
 }

package/dist/esm/pm-plugins/keymap.js

@@ -1,6 +1,6 @@
 import { getLinkMatch } from '@atlaskit/adf-schema';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import { addLink, bindKeymapWithCommand, bindKeymapWithPluginCommand, enter, escape, insertNewLine } from '@atlaskit/editor-common/keymaps';
+import { addLink, bindKeymapWithCommand, bindKeymapWithEditorCommand, enter, escape, insertNewLine } from '@atlaskit/editor-common/keymaps';
 import { findFilepaths, getLinkCreationAnalyticsEvent, isLinkInMatches } from '@atlaskit/editor-common/utils';
 import { keymap } from '@atlaskit/editor-prosemirror/keymap';
 import { hideLinkToolbar, showLinkToolbar } from '../commands';
@@ -9,7 +9,7 @@ export function createKeymapPlugin() {
   var skipAnalytics = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
   var editorAnalyticsApi = arguments.length > 1 ? arguments[1] : undefined;
   var list = {};
-  bindKeymapWithPluginCommand(addLink.common, showLinkToolbar(INPUT_METHOD.SHORTCUT, editorAnalyticsApi), list);
+  bindKeymapWithEditorCommand(addLink.common, showLinkToolbar(INPUT_METHOD.SHORTCUT, editorAnalyticsApi), list);
   bindKeymapWithCommand(enter.common, mayConvertLastWordToHyperlink(skipAnalytics, editorAnalyticsApi), list);
   bindKeymapWithCommand(insertNewLine.common, mayConvertLastWordToHyperlink(skipAnalytics, editorAnalyticsApi), list);
   bindKeymapWithCommand(escape.common, function (state, dispatch, view) {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-plugin-hyperlink",
-	"version": "0.3.0",
+	"version": "0.3.2",
 	"sideEffects": false
 }

package/dist/types/commands.d.ts

@@ -1,7 +1,7 @@
 import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command, LinkInputType, PluginCommand } from '@atlaskit/editor-common/types';
+import type { Command, EditorCommand, LinkInputType } from '@atlaskit/editor-common/types';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function setLinkHref(href: string, pos: number, editorAnalyticsApi: EditorAnalyticsAPI | undefined, to?: number, isTabPressed?: boolean): Command;
 export type UpdateLink = (href: string, text: string, pos: number, to?: number) => Command;
@@ -12,8 +12,8 @@ export declare const insertLinkWithAnalytics: (inputMethod: LinkInputType, from:
 export declare function removeLink(pos: number, editorAnalyticsApi: EditorAnalyticsAPI | undefined): Command;
 export declare function editInsertedLink(editorAnalyticsApi: EditorAnalyticsAPI | undefined): Command;
 type InputMethod = INPUT_METHOD.TOOLBAR | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.SHORTCUT | INPUT_METHOD.INSERT_MENU;
-export type ShowLinkToolbar = (inputMethod: InputMethod) => PluginCommand;
-export declare function showLinkToolbar(inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): PluginCommand;
+export type ShowLinkToolbar = (inputMethod: InputMethod) => EditorCommand;
+export declare function showLinkToolbar(inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): EditorCommand;
 export declare function hideLinkToolbar(): Command;
 export type HideLinkToolbar = (tr: Transaction) => Transaction;
 export declare const hideLinkToolbarSetMeta: HideLinkToolbar;

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export { hyperlinkPlugin } from './plugin';
+export type { HyperlinkPlugin } from './plugin';
 export type { HideLinkToolbar, ShowLinkToolbar, InsertLink, UpdateLink, } from './commands';
 export type { PrependToolbarButtons } from './pm-plugins/toolbar-buttons';

package/dist/types/plugin.d.ts

@@ -4,7 +4,7 @@ import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
 import type { HideLinkToolbar, InsertLink, ShowLinkToolbar, UpdateLink } from './commands';
 import type { PrependToolbarButtons } from './pm-plugins/toolbar-buttons';
-export declare const hyperlinkPlugin: NextEditorPlugin<'hyperlink', {
+export type HyperlinkPlugin = NextEditorPlugin<'hyperlink', {
     pluginConfiguration: HyperlinkPluginOptions | undefined;
     dependencies: [
         typeof featureFlagsPlugin,
@@ -26,7 +26,7 @@ export declare const hyperlinkPlugin: NextEditorPlugin<'hyperlink', {
     };
     commands: {
         /**
-         * PluginCommand to show link toolbar.
+         * EditorCommand to show link toolbar.
          *
          * Example:
          *
@@ -40,3 +40,4 @@ export declare const hyperlinkPlugin: NextEditorPlugin<'hyperlink', {
     };
     sharedState: HyperlinkState | undefined;
 }>;
+export declare const hyperlinkPlugin: HyperlinkPlugin;

package/dist/types/pm-plugins/toolbar-buttons.d.ts

@@ -18,5 +18,5 @@ interface PrependToolbarButtonsProps extends HyperlinkToolbarItemsState {
 }
 export type PrependToolbarButtons = (props: PrependToolbarButtonsProps) => void;
 export declare const prependToolbarButtons: ({ items, onEscapeCallback, onInsertLinkCallback, view, }: PrependToolbarButtonsProps) => void;
-export declare const toolbarButtonsPlugin: () => SafePlugin<HyperlinkToolbarItemsState | undefined>;
+export declare const toolbarButtonsPlugin: () => SafePlugin<undefined>;
 export {};

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

@@ -1,7 +1,7 @@
 import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command, LinkInputType, PluginCommand } from '@atlaskit/editor-common/types';
+import type { Command, EditorCommand, LinkInputType } from '@atlaskit/editor-common/types';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function setLinkHref(href: string, pos: number, editorAnalyticsApi: EditorAnalyticsAPI | undefined, to?: number, isTabPressed?: boolean): Command;
 export type UpdateLink = (href: string, text: string, pos: number, to?: number) => Command;
@@ -12,8 +12,8 @@ export declare const insertLinkWithAnalytics: (inputMethod: LinkInputType, from:
 export declare function removeLink(pos: number, editorAnalyticsApi: EditorAnalyticsAPI | undefined): Command;
 export declare function editInsertedLink(editorAnalyticsApi: EditorAnalyticsAPI | undefined): Command;
 type InputMethod = INPUT_METHOD.TOOLBAR | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.SHORTCUT | INPUT_METHOD.INSERT_MENU;
-export type ShowLinkToolbar = (inputMethod: InputMethod) => PluginCommand;
-export declare function showLinkToolbar(inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): PluginCommand;
+export type ShowLinkToolbar = (inputMethod: InputMethod) => EditorCommand;
+export declare function showLinkToolbar(inputMethod: InputMethod, editorAnalyticsApi: EditorAnalyticsAPI | undefined): EditorCommand;
 export declare function hideLinkToolbar(): Command;
 export type HideLinkToolbar = (tr: Transaction) => Transaction;
 export declare const hideLinkToolbarSetMeta: HideLinkToolbar;

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

@@ -1,3 +1,4 @@
 export { hyperlinkPlugin } from './plugin';
+export type { HyperlinkPlugin } from './plugin';
 export type { HideLinkToolbar, ShowLinkToolbar, InsertLink, UpdateLink, } from './commands';
 export type { PrependToolbarButtons } from './pm-plugins/toolbar-buttons';

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

@@ -4,7 +4,7 @@ import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
 import type { HideLinkToolbar, InsertLink, ShowLinkToolbar, UpdateLink } from './commands';
 import type { PrependToolbarButtons } from './pm-plugins/toolbar-buttons';
-export declare const hyperlinkPlugin: NextEditorPlugin<'hyperlink', {
+export type HyperlinkPlugin = NextEditorPlugin<'hyperlink', {
     pluginConfiguration: HyperlinkPluginOptions | undefined;
     dependencies: [
         typeof featureFlagsPlugin,
@@ -26,7 +26,7 @@ export declare const hyperlinkPlugin: NextEditorPlugin<'hyperlink', {
     };
     commands: {
         /**
-         * PluginCommand to show link toolbar.
+         * EditorCommand to show link toolbar.
          *
          * Example:
          *
@@ -40,3 +40,4 @@ export declare const hyperlinkPlugin: NextEditorPlugin<'hyperlink', {
     };
     sharedState: HyperlinkState | undefined;
 }>;
+export declare const hyperlinkPlugin: HyperlinkPlugin;

package/dist/types-ts4.5/pm-plugins/toolbar-buttons.d.ts

@@ -18,5 +18,5 @@ interface PrependToolbarButtonsProps extends HyperlinkToolbarItemsState {
 }
 export type PrependToolbarButtons = (props: PrependToolbarButtonsProps) => void;
 export declare const prependToolbarButtons: ({ items, onEscapeCallback, onInsertLinkCallback, view, }: PrependToolbarButtonsProps) => void;
-export declare const toolbarButtonsPlugin: () => SafePlugin<HyperlinkToolbarItemsState | undefined>;
+export declare const toolbarButtonsPlugin: () => SafePlugin<undefined>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-hyperlink",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Hyperlink plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -31,12 +31,12 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/adf-schema": "^28.0.0",
+    "@atlaskit/adf-schema": "^28.1.0",
     "@atlaskit/analytics-next": "^9.1.0",
-    "@atlaskit/editor-common": "^74.38.0",
+    "@atlaskit/editor-common": "^74.46.0",
     "@atlaskit/editor-plugin-analytics": "^0.1.0",
     "@atlaskit/editor-plugin-feature-flags": "^0.1.0",
-    "@atlaskit/editor-prosemirror": "1.0.2",
+    "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/prosemirror-input-rules": "^2.4.0",
@@ -49,7 +49,7 @@
   },
   "devDependencies": {
     "@atlaskit/activity-provider": "^2.4.0",
-    "@atlaskit/editor-test-helpers": "^18.9.0",
+    "@atlaskit/editor-test-helpers": "^18.11.0",
     "@atlaskit/link-test-helpers": "^6.0.0",
     "@atlaskit/media-test-helpers": "^33.0.0",
     "@atlaskit/ssr": "*",

package/report.api.md

@@ -17,6 +17,7 @@
 ```ts
 import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { Command } from '@atlaskit/editor-common/types';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
@@ -28,7 +29,6 @@ import type { IntlShape } from 'react-intl-next';
 import type { LinkInputType } from '@atlaskit/editor-common/types';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { OptionalPlugin } from '@atlaskit/editor-common/types';
-import type { PluginCommand } from '@atlaskit/editor-common/types';
 import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import type { QueueCardsFromTransactionAction } from '@atlaskit/editor-common/card';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
@@ -46,7 +46,7 @@ type GetToolbarItems = (
 export type HideLinkToolbar = (tr: Transaction) => Transaction;
 
 // @public (undocumented)
-export const hyperlinkPlugin: NextEditorPlugin<
+export type HyperlinkPlugin = NextEditorPlugin<
   'hyperlink',
   {
     pluginConfiguration: HyperlinkPluginOptions | undefined;
@@ -67,6 +67,9 @@ export const hyperlinkPlugin: NextEditorPlugin<
   }
 >;
 
+// @public (undocumented)
+export const hyperlinkPlugin: HyperlinkPlugin;
+
 // @public (undocumented)
 type HyperlinkToolbarItemsState = {
   items: GetToolbarItems;
@@ -103,7 +106,7 @@ interface PrependToolbarButtonsProps extends HyperlinkToolbarItemsState {
 }
 
 // @public (undocumented)
-export type ShowLinkToolbar = (inputMethod: InputMethod) => PluginCommand;
+export type ShowLinkToolbar = (inputMethod: InputMethod) => EditorCommand;
 
 // @public (undocumented)
 export type UpdateLink = (

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

@@ -6,6 +6,7 @@
 
 import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { Command } from '@atlaskit/editor-common/types';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
@@ -17,7 +18,6 @@ import type { IntlShape } from 'react-intl-next';
 import type { LinkInputType } from '@atlaskit/editor-common/types';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { OptionalPlugin } from '@atlaskit/editor-common/types';
-import type { PluginCommand } from '@atlaskit/editor-common/types';
 import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import type { QueueCardsFromTransactionAction } from '@atlaskit/editor-common/card';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
@@ -30,7 +30,7 @@ type GetToolbarItems = (state: EditorState, intl: IntlShape, providerFactory: Pr
 export type HideLinkToolbar = (tr: Transaction) => Transaction;
 
 // @public (undocumented)
-export const hyperlinkPlugin: NextEditorPlugin<'hyperlink', {
+export type HyperlinkPlugin = NextEditorPlugin<'hyperlink', {
     pluginConfiguration: HyperlinkPluginOptions | undefined;
     dependencies: [
     typeof featureFlagsPlugin,
@@ -48,6 +48,9 @@ export const hyperlinkPlugin: NextEditorPlugin<'hyperlink', {
     sharedState: HyperlinkState | undefined;
 }>;
 
+// @public (undocumented)
+export const hyperlinkPlugin: HyperlinkPlugin;
+
 // @public (undocumented)
 type HyperlinkToolbarItemsState = {
     items: GetToolbarItems;
@@ -71,7 +74,7 @@ interface PrependToolbarButtonsProps extends HyperlinkToolbarItemsState {
 }
 
 // @public (undocumented)
-export type ShowLinkToolbar = (inputMethod: InputMethod) => PluginCommand;
+export type ShowLinkToolbar = (inputMethod: InputMethod) => EditorCommand;
 
 // @public (undocumented)
 export type UpdateLink = (href: string, text: string, pos: number, to?: number) => Command;