@atlaskit/editor-common 104.1.2 → 104.1.3

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/editor-common
 
+## 104.1.3
+
+### Patch Changes
+
+- [#142925](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/142925)
+  [`e013698350bef`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e013698350bef) -
+  This updates the renderer to use the new annotation manager create comment APIs and disables the
+  use of the old create hooks. This should be backward compatible and can be controled by a FG
+- Updated dependencies
+
 ## 104.1.2
 
 ### Patch Changes

package/dist/cjs/annotation/index.js

@@ -35,7 +35,6 @@ var AnnotationUpdateEmitter = exports.AnnotationUpdateEmitter = /*#__PURE__*/fun
     }
   }]);
 }(_events.EventEmitter); // type ActionResult = { step: Step; doc: JSONDocNode } | false;
-// } & AnnotationByMatches)
 // | false;
 // ### Events
 // ### Hook Results

package/dist/cjs/monitoring/error.js

@@ -17,7 +17,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "104.1.2";
+var packageVersion = "104.1.3";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/ui/DropList/index.js

@@ -23,7 +23,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "104.1.2";
+var packageVersion = "104.1.3";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/es2019/annotation/index.js

@@ -11,7 +11,6 @@ export class AnnotationUpdateEmitter extends EventEmitter {
 
 // type ActionResult = { step: Step; doc: JSONDocNode } | false;
 
-// } & AnnotationByMatches)
 // | false;
 
 // ### Events

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "104.1.2";
+const packageVersion = "104.1.3";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/ui/DropList/index.js

@@ -13,7 +13,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "104.1.2";
+const packageVersion = "104.1.3";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/esm/annotation/index.js

@@ -30,7 +30,6 @@ export var AnnotationUpdateEmitter = /*#__PURE__*/function (_EventEmitter) {
 
 // type ActionResult = { step: Step; doc: JSONDocNode } | false;
 
-// } & AnnotationByMatches)
 // | false;
 
 // ### Events

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "104.1.2";
+var packageVersion = "104.1.3";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/ui/DropList/index.js

@@ -20,7 +20,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "104.1.2";
+var packageVersion = "104.1.3";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/types/annotation/index.d.ts

@@ -4,7 +4,7 @@
 import { EventEmitter } from 'events';
 import type { AnnotationId } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AddNodeMarkStep, AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve' | 'setselectedannotation' | 'sethoveredannotation' | 'removehoveredannotation' | 'closeinlinecomment';
 export type VisibilityEvent = 'setvisibility';
 type AnnotationCallback = (params: string) => void;
@@ -14,13 +14,19 @@ export declare class AnnotationUpdateEmitter extends EventEmitter {
     on(event: UpdateEvent, listener: (annotationId: string) => void): this;
     off(event: string, listener: AnnotationCallback | VisibilityCallback): this;
 }
-type ActionResult = {
-    step: Step;
+type AnnotationByMatches = {
+    originalSelection: string;
+    numMatches: number;
+    matchIndex: number;
+    pos?: number;
+};
+export type ActionResult = {
+    step: AddMarkStep | AddNodeMarkStep;
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];
     targetNodeType?: string;
-};
+} & AnnotationByMatches;
 export type AnnotationDraftStartedData = {
     targetElement: HTMLElement | undefined;
     /**
@@ -64,6 +70,11 @@ export type ApplyDraftResult = {
 } | {
     success: true;
     targetElement: HTMLElement | undefined;
+    /**
+     * The actionResult will be set if the id passed to the applyDraft method is different from the id created
+     * from the startDraft call.
+     */
+    actionResult: ActionResult | undefined;
 };
 export type GetDraftResult = {
     success: false;
@@ -99,7 +110,21 @@ export type AnnotationManagerMethods = {
     allowAnnotation: () => boolean;
     startDraft: () => StartDraftResult;
     clearDraft: () => ClearDraftResult;
+    /**
+     * This will apply the current draft to the document.
+     *
+     * If an id is passed, it will be used to apply the draft, it will
+     * also generate a new actionResult value if the passed id is different from the one returned from the startDraft method.
+     *
+     * @param id The id of the annotation to apply. Ideally the same as the one returned from the startDraft method.
+     * If the id is different, the actionResult will contain a step and document with the new id. Changing the id is discouraged
+     * as this creates different behaviour between the editor and renderer.
+     */
     applyDraft: (id: AnnotationId) => ApplyDraftResult;
+    /**
+     * This can be used to inspect the current active draft.
+     * @returns The current draft data. If the draft is not started, it will return an error.
+     */
     getDraft: () => GetDraftResult;
     setIsAnnotationSelected: (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
     setIsAnnotationHovered: (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
@@ -113,6 +138,7 @@ export type AnnotationManager = AnnotationManagerMethods & {
     setPreemptiveGate(handler: () => Promise<boolean>): AnnotationManager;
     /**
      * This method is used to run the configured preemptive gate check.
+     * @private
      * @internal
      */
     checkPreemptiveGate(): Promise<boolean>;
@@ -121,6 +147,7 @@ export type AnnotationManager = AnnotationManagerMethods & {
     onAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     offAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     /**
+     * @private
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */
@@ -132,11 +159,13 @@ export type AnnotationManager = AnnotationManagerMethods & {
         data: AnnotationSelectedChangeData;
     }): AnnotationManager;
     /**
+     * @private
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */
     hook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
     /**
+     *
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */

package/dist/types/types/annotation/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { AnnotationId, AnnotationTypes } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AddNodeMarkStep, AddMarkStep, Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnnotationManager } from '../../annotation';
 import type { AnnotationState, AnnotationUpdateEmitter } from './emitter';
 export type AnnotationByMatches = {
@@ -16,7 +16,7 @@ type ActionResult = {
     doc: JSONDocNode;
 } | false;
 export type AnnotationActionResult = ({
-    step: Step;
+    step: AddMarkStep | AddNodeMarkStep;
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];

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

@@ -4,7 +4,7 @@
 import { EventEmitter } from 'events';
 import type { AnnotationId } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AddNodeMarkStep, AddMarkStep } from '@atlaskit/editor-prosemirror/transform';
 export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve' | 'setselectedannotation' | 'sethoveredannotation' | 'removehoveredannotation' | 'closeinlinecomment';
 export type VisibilityEvent = 'setvisibility';
 type AnnotationCallback = (params: string) => void;
@@ -14,13 +14,19 @@ export declare class AnnotationUpdateEmitter extends EventEmitter {
     on(event: UpdateEvent, listener: (annotationId: string) => void): this;
     off(event: string, listener: AnnotationCallback | VisibilityCallback): this;
 }
-type ActionResult = {
-    step: Step;
+type AnnotationByMatches = {
+    originalSelection: string;
+    numMatches: number;
+    matchIndex: number;
+    pos?: number;
+};
+export type ActionResult = {
+    step: AddMarkStep | AddNodeMarkStep;
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];
     targetNodeType?: string;
-};
+} & AnnotationByMatches;
 export type AnnotationDraftStartedData = {
     targetElement: HTMLElement | undefined;
     /**
@@ -64,6 +70,11 @@ export type ApplyDraftResult = {
 } | {
     success: true;
     targetElement: HTMLElement | undefined;
+    /**
+     * The actionResult will be set if the id passed to the applyDraft method is different from the id created
+     * from the startDraft call.
+     */
+    actionResult: ActionResult | undefined;
 };
 export type GetDraftResult = {
     success: false;
@@ -99,7 +110,21 @@ export type AnnotationManagerMethods = {
     allowAnnotation: () => boolean;
     startDraft: () => StartDraftResult;
     clearDraft: () => ClearDraftResult;
+    /**
+     * This will apply the current draft to the document.
+     *
+     * If an id is passed, it will be used to apply the draft, it will
+     * also generate a new actionResult value if the passed id is different from the one returned from the startDraft method.
+     *
+     * @param id The id of the annotation to apply. Ideally the same as the one returned from the startDraft method.
+     * If the id is different, the actionResult will contain a step and document with the new id. Changing the id is discouraged
+     * as this creates different behaviour between the editor and renderer.
+     */
     applyDraft: (id: AnnotationId) => ApplyDraftResult;
+    /**
+     * This can be used to inspect the current active draft.
+     * @returns The current draft data. If the draft is not started, it will return an error.
+     */
     getDraft: () => GetDraftResult;
     setIsAnnotationSelected: (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
     setIsAnnotationHovered: (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
@@ -113,6 +138,7 @@ export type AnnotationManager = AnnotationManagerMethods & {
     setPreemptiveGate(handler: () => Promise<boolean>): AnnotationManager;
     /**
      * This method is used to run the configured preemptive gate check.
+     * @private
      * @internal
      */
     checkPreemptiveGate(): Promise<boolean>;
@@ -121,6 +147,7 @@ export type AnnotationManager = AnnotationManagerMethods & {
     onAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     offAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
     /**
+     * @private
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */
@@ -132,11 +159,13 @@ export type AnnotationManager = AnnotationManagerMethods & {
         data: AnnotationSelectedChangeData;
     }): AnnotationManager;
     /**
+     * @private
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */
     hook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
     /**
+     *
      * @internal
      * This method is intended for internal Platform use only. It is not intended for use by Product code.
      */

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { AnnotationId, AnnotationTypes } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
-import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AddNodeMarkStep, AddMarkStep, Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnnotationManager } from '../../annotation';
 import type { AnnotationState, AnnotationUpdateEmitter } from './emitter';
 export type AnnotationByMatches = {
@@ -16,7 +16,7 @@ type ActionResult = {
     doc: JSONDocNode;
 } | false;
 export type AnnotationActionResult = ({
-    step: Step;
+    step: AddMarkStep | AddNodeMarkStep;
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "104.1.2",
+	"version": "104.1.3",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"