@atlaskit/editor-plugin-annotation 1.0.2 → 1.2.0

package/dist/types/types.d.ts

@@ -1,22 +1,40 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
+import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
-import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { Command, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { Slice } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { InlineCommentPluginState } from './pm-plugins/types';
 type StripNonExistingAnnotations = (slice: Slice, state: EditorState) => boolean | undefined;
+/**
+ * type of target that annotation apply to.
+ * This is used to apply correct decoration to a draft comment
+ */
+export type TargetType = 'block' | 'inline';
+/**
+ * The source of draft comment being created
+ */
+export type InlineCommentInputMethod = INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT | INPUT_METHOD.FLOATING_TB;
+type SetInlineCommentDraftState = (drafting: boolean, inputMethod: InlineCommentInputMethod, 
+/** @default 'inline' */
+targetType?: TargetType, 
+/** check for platform_editor_media_comments_base feature gate */
+isCommentOnMediaOn?: boolean) => Command;
 export type AnnotationPlugin = NextEditorPlugin<'annotation', {
     pluginConfiguration: AnnotationProviders | undefined;
     sharedState: InlineCommentPluginState | undefined;
     dependencies: [
         OptionalPlugin<AnalyticsPlugin>,
-        OptionalPlugin<EditorViewModePlugin>
+        OptionalPlugin<EditorViewModePlugin>,
+        OptionalPlugin<FeatureFlagsPlugin>
     ];
     actions: {
         stripNonExistingAnnotations: StripNonExistingAnnotations;
+        setInlineCommentDraftState: SetInlineCommentDraftState;
     };
 }>;
 export type AnnotationInfo = {

package/dist/types/utils.d.ts

@@ -1,11 +1,11 @@
-import type { AnalyticsEventPayloadCallback, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { AnalyticsEventPayloadCallback } from '@atlaskit/editor-common/analytics';
 import { containsAnyAnnotations, hasAnnotationMark } from '@atlaskit/editor-common/utils';
 import type { Mark, Node, ResolvedPos, Schema, Slice } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
 import { AllSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import type { InlineCommentPluginState } from './pm-plugins/types';
-import type { AnnotationInfo } from './types';
+import type { AnnotationInfo, InlineCommentInputMethod, TargetType } from './types';
 import { AnnotationSelectionType } from './types';
 export { hasAnnotationMark, containsAnyAnnotations };
 /**
@@ -14,7 +14,7 @@ export { hasAnnotationMark, containsAnyAnnotations };
  */
 export declare const surroundingMarks: ($pos: ResolvedPos) => (readonly Mark[])[];
 export declare const getAllAnnotations: (doc: Node) => string[];
-export declare const addDraftDecoration: (start: number, end: number) => Decoration;
+export declare const addDraftDecoration: (start: number, end: number, targetType?: TargetType) => Decoration;
 export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
 export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
 /**
@@ -27,8 +27,8 @@ export declare const getPluginState: (state: EditorState) => InlineCommentPlugin
 /**
  * get payload for the open/close analytics event
  */
-export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => AnalyticsEventPayloadCallback;
-export declare const isSelectionValid: (state: EditorState) => AnnotationSelectionType;
+export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: InlineCommentInputMethod) => AnalyticsEventPayloadCallback;
+export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean) => AnnotationSelectionType;
 export declare const hasInvalidNodes: (state: EditorState) => boolean;
 /**
  * Checks if any of the nodes in a given selection are completely whitespace

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

@@ -1,14 +1,13 @@
 import { AnnotationTypes } from '@atlaskit/adf-schema';
 import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
-import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { Command, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { InlineCommentMap, InlineCommentMouseData } from '../pm-plugins/types';
-import type { AnnotationPlugin } from '../types';
+import type { AnnotationPlugin, InlineCommentInputMethod, TargetType } from '../types';
 export declare const updateInlineCommentResolvedState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (partialNewState: InlineCommentMap, resolveMethod?: RESOLVE_METHOD) => Command;
 export declare const closeComponent: () => Command;
 export declare const clearDirtyMark: () => Command;
 export declare const removeInlineCommentNearSelection: (id: string) => Command;
-export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, inputMethod?: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => Command;
+export declare const setInlineCommentDraftState: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, inputMethod?: InlineCommentInputMethod, targetType?: TargetType, isCommentOnMediaOn?: boolean) => Command;
 export declare const addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI?: ExtractInjectionAPI<AnnotationPlugin> | undefined) => (id: string) => Command;
 export declare const updateMouseState: (mouseData: InlineCommentMouseData) => Command;
 export declare const setSelectedAnnotation: (id: string) => Command;

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

@@ -1,6 +1,6 @@
-import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { EditorAnalyticsAPI, RESOLVE_METHOD } from '@atlaskit/editor-common/analytics';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { InlineCommentInputMethod } from '../types';
 declare const _default: {
     addAnnotationMark: (id: string) => (transaction: Transaction, state: EditorState) => Transaction;
     addInlineComment: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined, editorAPI: import("@atlaskit/editor-common/types").PublicPluginAPI<[
@@ -74,10 +74,15 @@ declare const _default: {
                     };
                 }, {
                     mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
-                } | undefined>>
+                } | undefined>>,
+                import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
+                    pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
+                    sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
+                }, import("@atlaskit/editor-common/types").FeatureFlags>>
             ];
             actions: {
                 stripNonExistingAnnotations: (slice: import("prosemirror-model").Slice, state: EditorState) => boolean | undefined;
+                setInlineCommentDraftState: (drafting: boolean, inputMethod: InlineCommentInputMethod, targetType?: import("../types").TargetType | undefined, isCommentOnMediaOn?: boolean | undefined) => import("@atlaskit/editor-common/types").Command;
             };
         }, import("../types").AnnotationProviders | undefined>,
         import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {
@@ -146,9 +151,13 @@ declare const _default: {
             };
         }, {
             mode?: import("@atlaskit/editor-plugin-editor-viewmode").ViewMode | undefined;
-        } | undefined>>
+        } | undefined>>,
+        import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"featureFlags", {
+            pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
+            sharedState: import("@atlaskit/editor-common/types").FeatureFlags;
+        }, import("@atlaskit/editor-common/types").FeatureFlags>>
     ]> | undefined) => (id: string) => (transaction: Transaction, state: EditorState) => Transaction;
-    addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: INPUT_METHOD.SHORTCUT | INPUT_METHOD.TOOLBAR) => (transaction: Transaction, state: EditorState) => Transaction;
+    addOpenCloseAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (drafting: boolean, method?: InlineCommentInputMethod) => (transaction: Transaction, state: EditorState) => Transaction;
     addInsertAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
     addResolveAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (method?: RESOLVE_METHOD | undefined) => (transaction: Transaction, state: EditorState) => Transaction;
 };

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

@@ -1,3 +1,3 @@
 export { annotationPlugin } from './plugin';
-export type { AnnotationPlugin, AnnotationProviders, InlineCommentAnnotationProvider, AnnotationInfo, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationState, AnnotationTypeProvider, InlineCommentState, } from './types';
+export type { AnnotationPlugin, AnnotationProviders, InlineCommentAnnotationProvider, AnnotationInfo, InlineCommentCreateComponentProps, InlineCommentViewComponentProps, AnnotationState, AnnotationTypeProvider, InlineCommentState, TargetType, InlineCommentInputMethod, } from './types';
 export type { InlineCommentMap, InlineCommentPluginState, InlineCommentPluginOptions, InlineCommentAction, } from './pm-plugins/types';

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

@@ -3,7 +3,7 @@ import type { Dispatch, EventDispatcher } from '@atlaskit/editor-common/event-di
 import type { PortalProviderAPI } from '@atlaskit/editor-common/portal-provider';
 import type { EditorState, SelectionBookmark } from '@atlaskit/editor-prosemirror/state';
 import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import type { AnnotationInfo, InlineCommentAnnotationProvider } from '../types';
+import type { AnnotationInfo, InlineCommentAnnotationProvider, TargetType } from '../types';
 export declare enum ACTIONS {
     UPDATE_INLINE_COMMENT_STATE = 0,
     SET_INLINE_COMMENT_DRAFT_STATE = 1,
@@ -35,6 +35,7 @@ export type InlineCommentAction = {
     data: {
         drafting: boolean;
         editorState: EditorState;
+        targetType?: TargetType;
     };
 } | {
     type: ACTIONS.INLINE_COMMENT_UPDATE_MOUSE_STATE;

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

@@ -2,4 +2,4 @@ import type { IntlShape } from 'react-intl-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { FloatingToolbarConfig } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean) => FloatingToolbarConfig | undefined;
+export declare const buildToolbar: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (state: EditorState, intl: IntlShape, isToolbarAbove?: boolean, isCommentOnMediaOn?: boolean) => FloatingToolbarConfig | undefined;

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

@@ -1,22 +1,40 @@
 import type React from 'react';
 import type { AnnotationTypes } from '@atlaskit/adf-schema';
+import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { AnnotationUpdateEmitter } from '@atlaskit/editor-common/annotation';
-import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { Command, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { Slice } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { InlineCommentPluginState } from './pm-plugins/types';
 type StripNonExistingAnnotations = (slice: Slice, state: EditorState) => boolean | undefined;
+/**
+ * type of target that annotation apply to.
+ * This is used to apply correct decoration to a draft comment
+ */
+export type TargetType = 'block' | 'inline';
+/**
+ * The source of draft comment being created
+ */
+export type InlineCommentInputMethod = INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT | INPUT_METHOD.FLOATING_TB;
+type SetInlineCommentDraftState = (drafting: boolean, inputMethod: InlineCommentInputMethod, 
+/** @default 'inline' */
+targetType?: TargetType, 
+/** check for platform_editor_media_comments_base feature gate */
+isCommentOnMediaOn?: boolean) => Command;
 export type AnnotationPlugin = NextEditorPlugin<'annotation', {
     pluginConfiguration: AnnotationProviders | undefined;
     sharedState: InlineCommentPluginState | undefined;
     dependencies: [
         OptionalPlugin<AnalyticsPlugin>,
-        OptionalPlugin<EditorViewModePlugin>
+        OptionalPlugin<EditorViewModePlugin>,
+        OptionalPlugin<FeatureFlagsPlugin>
     ];
     actions: {
         stripNonExistingAnnotations: StripNonExistingAnnotations;
+        setInlineCommentDraftState: SetInlineCommentDraftState;
     };
 }>;
 export type AnnotationInfo = {

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

@@ -1,11 +1,11 @@
-import type { AnalyticsEventPayloadCallback, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { AnalyticsEventPayloadCallback } from '@atlaskit/editor-common/analytics';
 import { containsAnyAnnotations, hasAnnotationMark } from '@atlaskit/editor-common/utils';
 import type { Mark, Node, ResolvedPos, Schema, Slice } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
 import { AllSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { Decoration } from '@atlaskit/editor-prosemirror/view';
 import type { InlineCommentPluginState } from './pm-plugins/types';
-import type { AnnotationInfo } from './types';
+import type { AnnotationInfo, InlineCommentInputMethod, TargetType } from './types';
 import { AnnotationSelectionType } from './types';
 export { hasAnnotationMark, containsAnyAnnotations };
 /**
@@ -14,7 +14,7 @@ export { hasAnnotationMark, containsAnyAnnotations };
  */
 export declare const surroundingMarks: ($pos: ResolvedPos) => (readonly Mark[])[];
 export declare const getAllAnnotations: (doc: Node) => string[];
-export declare const addDraftDecoration: (start: number, end: number) => Decoration;
+export declare const addDraftDecoration: (start: number, end: number, targetType?: TargetType) => Decoration;
 export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
 export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
 /**
@@ -27,8 +27,8 @@ export declare const getPluginState: (state: EditorState) => InlineCommentPlugin
 /**
  * get payload for the open/close analytics event
  */
-export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => AnalyticsEventPayloadCallback;
-export declare const isSelectionValid: (state: EditorState) => AnnotationSelectionType;
+export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: InlineCommentInputMethod) => AnalyticsEventPayloadCallback;
+export declare const isSelectionValid: (state: EditorState, isCommentOnMediaOn?: boolean) => AnnotationSelectionType;
 export declare const hasInvalidNodes: (state: EditorState) => boolean;
 /**
  * Checks if any of the nodes in a given selection are completely whitespace

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-annotation",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "Annotation plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -33,9 +33,10 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^35.5.2",
-    "@atlaskit/editor-common": "^78.10.0",
+    "@atlaskit/editor-common": "^78.11.0",
     "@atlaskit/editor-plugin-analytics": "^1.0.0",
     "@atlaskit/editor-plugin-editor-viewmode": "^1.0.0",
+    "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/icon": "^22.1.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",
@@ -93,9 +94,6 @@
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0",
   "platform-feature-flags": {
-    "platform.editor.annotation.decouple-inline-comment-closed_flmox": {
-      "type": "boolean"
-    },
     "platform.editor.enable-selection-toolbar_ucdwd": {
       "type": "boolean"
     }