@atlaskit/editor-plugin-copy-button 0.1.0 → 0.2.0

package/dist/types/types.d.ts

@@ -1,6 +1,13 @@
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { MarkType } from '@atlaskit/editor-prosemirror/model';
-export type CopyButtonPlugin = NextEditorPlugin<'copyButton'>;
+declare const processCopyButtonItemsWithAnalytics: (state: import("prosemirror-state").EditorState) => (items: import("@atlaskit/editor-common/types").FloatingToolbarItem<import("@atlaskit/editor-common/types").Command>[], hoverDecoration: ((nodeType: import("prosemirror-model").NodeType | import("prosemirror-model").NodeType[], add: boolean, className?: string | undefined) => import("@atlaskit/editor-common/types").Command) | undefined) => import("@atlaskit/editor-common/types").FloatingToolbarItem<import("@atlaskit/editor-common/types").Command>[];
+export type CopyButtonPlugin = NextEditorPlugin<'copyButton', {
+    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    actions: {
+        processCopyButtonItems: typeof processCopyButtonItemsWithAnalytics;
+    };
+}>;
 export type CopyButtonPluginState = {
     copied: boolean;
     markSelection?: {
@@ -9,3 +16,4 @@ export type CopyButtonPluginState = {
         markType: MarkType;
     };
 };
+export {};

package/dist/types/utils.d.ts

@@ -0,0 +1,7 @@
+import type { NodeType, Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare function getSelectedNodeOrNodeParentByNodeType({ nodeType, selection, }: {
+    nodeType: NodeType | Array<NodeType>;
+    selection: Transaction['selection'];
+}): import("prosemirror-utils/dist/types").FindResult;
+export declare const toDOM: (node: PMNode, schema: Schema) => Node;

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

@@ -0,0 +1,10 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { Command, CommandDispatch } from '@atlaskit/editor-common/types';
+import type { HoverDecorationHandler } from '@atlaskit/editor-plugin-decorations';
+import type { MarkType, NodeType } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare function createToolbarCopyCommandForMark(markType: MarkType, editorAnalyticsApi: EditorAnalyticsAPI | undefined): Command;
+export declare function getProvideMarkVisualFeedbackForCopyButtonCommand(markType: MarkType): (state: EditorState, dispatch: CommandDispatch | undefined) => boolean;
+export declare function removeMarkVisualFeedbackForCopyButtonCommand(state: EditorState, dispatch: CommandDispatch | undefined): boolean;
+export declare const createToolbarCopyCommandForNode: (nodeType: NodeType | Array<NodeType>, editorAnalyticsApi: EditorAnalyticsAPI | undefined) => Command;
+export declare const resetCopiedState: (nodeType: NodeType | Array<NodeType>, hoverDecoration: HoverDecorationHandler | undefined, onMouseLeave?: Command) => Command;

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

@@ -1 +1,2 @@
 export type { CopyButtonPlugin, CopyButtonPluginState } from './types';
+export { copyButtonPlugin } from './plugin';

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

@@ -0,0 +1,2 @@
+import type { CopyButtonPlugin } from './types';
+export declare const copyButtonPlugin: CopyButtonPlugin;

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

@@ -0,0 +1,4 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { CopyButtonPluginState } from '../types';
+export declare function copyButtonPlugin(): SafePlugin<CopyButtonPluginState>;
+export default copyButtonPlugin;

package/dist/types-ts4.5/pm-plugins/plugin-key.d.ts

@@ -0,0 +1,2 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const copyButtonPluginKey: PluginKey<any>;

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

@@ -0,0 +1,13 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { Command, FloatingToolbarButton, FloatingToolbarItem, MarkOptions, NodeOptions } from '@atlaskit/editor-common/types';
+import type { HoverDecorationHandler } from '@atlaskit/editor-plugin-decorations';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare function getCopyButtonConfig(options: MarkOptions | NodeOptions, hoverDecoration: HoverDecorationHandler | undefined, editorAnalyticsApi: EditorAnalyticsAPI | undefined): FloatingToolbarButton<Command>;
+export declare const showCopyButton: (state?: EditorState) => import("prosemirror-state").Plugin<any> | undefined;
+/**
+ * Process floatingToolbar items for copyButton
+ *
+ * If copy button plugin not enabled, remove copy button item from toolbar items
+ * else process copy button to standard floatingtoobarbutton
+ */
+export declare const processCopyButtonItems: (editorAnalyticsApi?: EditorAnalyticsAPI | undefined) => (state: EditorState) => (items: Array<FloatingToolbarItem<Command>>, hoverDecoration: HoverDecorationHandler | undefined) => Array<FloatingToolbarItem<Command>>;

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

@@ -1,6 +1,15 @@
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { MarkType } from '@atlaskit/editor-prosemirror/model';
-export type CopyButtonPlugin = NextEditorPlugin<'copyButton'>;
+declare const processCopyButtonItemsWithAnalytics: (state: import("prosemirror-state").EditorState) => (items: import("@atlaskit/editor-common/types").FloatingToolbarItem<import("@atlaskit/editor-common/types").Command>[], hoverDecoration: ((nodeType: import("prosemirror-model").NodeType | import("prosemirror-model").NodeType[], add: boolean, className?: string | undefined) => import("@atlaskit/editor-common/types").Command) | undefined) => import("@atlaskit/editor-common/types").FloatingToolbarItem<import("@atlaskit/editor-common/types").Command>[];
+export type CopyButtonPlugin = NextEditorPlugin<'copyButton', {
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>
+    ];
+    actions: {
+        processCopyButtonItems: typeof processCopyButtonItemsWithAnalytics;
+    };
+}>;
 export type CopyButtonPluginState = {
     copied: boolean;
     markSelection?: {
@@ -9,3 +18,4 @@ export type CopyButtonPluginState = {
         markType: MarkType;
     };
 };
+export {};

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

@@ -0,0 +1,7 @@
+import type { NodeType, Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare function getSelectedNodeOrNodeParentByNodeType({ nodeType, selection, }: {
+    nodeType: NodeType | Array<NodeType>;
+    selection: Transaction['selection'];
+}): import("prosemirror-utils/dist/types").FindResult;
+export declare const toDOM: (node: PMNode, schema: Schema) => Node;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-copy-button",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "editor-plugin-copy-button for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -28,17 +28,23 @@
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "af:exports": {
-    ".": "./src/index.ts"
+    ".": "./src/index.ts",
+    "./toolbar": "./src/toolbar.ts",
+    "./utils": "./src/utils.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^75.0.2",
+    "@atlaskit/editor-common": "^75.2.0",
+    "@atlaskit/editor-plugin-analytics": "^0.2.0",
+    "@atlaskit/editor-plugin-decorations": "^0.2.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
+    "@atlaskit/icon": "^21.12.0",
     "@babel/runtime": "^7.0.0"
   },
   "peerDependencies": {
     "react": "^16.8.0"
   },
   "devDependencies": {
+    "@atlaskit/analytics-next": "^9.1.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@testing-library/react": "^12.1.5",
     "react-dom": "^16.8.0",

package/report.api.md

@@ -15,11 +15,28 @@
 <!--SECTION START: Main Entry Types-->
 
 ```ts
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import { Command } from '@atlaskit/editor-common/types';
+import { EditorState } from 'prosemirror-state';
+import { FloatingToolbarItem } from '@atlaskit/editor-common/types';
 import type { MarkType } from '@atlaskit/editor-prosemirror/model';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { NodeType } from 'prosemirror-model';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
 
 // @public (undocumented)
-export type CopyButtonPlugin = NextEditorPlugin<'copyButton'>;
+export type CopyButtonPlugin = NextEditorPlugin<
+  'copyButton',
+  {
+    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    actions: {
+      processCopyButtonItems: typeof processCopyButtonItemsWithAnalytics;
+    };
+  }
+>;
+
+// @public (undocumented)
+export const copyButtonPlugin: CopyButtonPlugin;
 
 // @public (undocumented)
 export type CopyButtonPluginState = {
@@ -31,6 +48,20 @@ export type CopyButtonPluginState = {
   };
 };
 
+// @public (undocumented)
+const processCopyButtonItemsWithAnalytics: (
+  state: EditorState,
+) => (
+  items: FloatingToolbarItem<Command>[],
+  hoverDecoration:
+    | ((
+        nodeType: NodeType | NodeType[],
+        add: boolean,
+        className?: string | undefined,
+      ) => Command)
+    | undefined,
+) => FloatingToolbarItem<Command>[];
+
 // (No @packageDocumentation comment for this package)
 ```
 

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

@@ -4,11 +4,25 @@
 
 ```ts
 
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import { Command } from '@atlaskit/editor-common/types';
+import { EditorState } from 'prosemirror-state';
+import { FloatingToolbarItem } from '@atlaskit/editor-common/types';
 import type { MarkType } from '@atlaskit/editor-prosemirror/model';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { NodeType } from 'prosemirror-model';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
 
 // @public (undocumented)
-export type CopyButtonPlugin = NextEditorPlugin<'copyButton'>;
+export type CopyButtonPlugin = NextEditorPlugin<'copyButton', {
+    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    actions: {
+        processCopyButtonItems: typeof processCopyButtonItemsWithAnalytics;
+    };
+}>;
+
+// @public (undocumented)
+export const copyButtonPlugin: CopyButtonPlugin;
 
 // @public (undocumented)
 export type CopyButtonPluginState = {
@@ -20,6 +34,9 @@ export type CopyButtonPluginState = {
     };
 };
 
+// @public (undocumented)
+const processCopyButtonItemsWithAnalytics: (state: EditorState) => (items: FloatingToolbarItem<Command>[], hoverDecoration: ((nodeType: NodeType | NodeType[], add: boolean, className?: string | undefined) => Command) | undefined) => FloatingToolbarItem<Command>[];
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/toolbar/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/editor-plugin-copy-button/toolbar",
+  "main": "../dist/cjs/toolbar.js",
+  "module": "../dist/esm/toolbar.js",
+  "module:es2019": "../dist/es2019/toolbar.js",
+  "sideEffects": false,
+  "types": "../dist/types/toolbar.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "../dist/types-ts4.5/toolbar.d.ts"
+      ]
+    }
+  }
+}

package/utils/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/editor-plugin-copy-button/utils",
+  "main": "../dist/cjs/utils.js",
+  "module": "../dist/esm/utils.js",
+  "module:es2019": "../dist/es2019/utils.js",
+  "sideEffects": false,
+  "types": "../dist/types/utils.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "../dist/types-ts4.5/utils.d.ts"
+      ]
+    }
+  }
+}