@atlaskit/editor-common 110.36.8 → 110.37.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-common
 
+## 110.37.0
+
+### Minor Changes
+
+- [`68206f30ef7be`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/68206f30ef7be) -
+  EDITOR-3577 - Pass doc and selection as additional context for comment when editing page
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 110.36.8
 
 ### Patch Changes

package/dist/cjs/monitoring/error.js

@@ -19,7 +19,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 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 = "110.36.7";
+var packageVersion = "110.36.8";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/preset/core-plugin/index.js

@@ -18,6 +18,7 @@ var corePlugin = exports.corePlugin = function corePlugin(_ref) {
   var config = _ref.config;
   // Create the document request throttler per editor (rather than at a module level)
   var scheduleDocumentRequest = (0, _requestDocument.createThrottleSchedule)(_requestDocument.returnDocumentRequest);
+  var scheduleDocumentRequestNoThrowError = (0, _requestDocument.createThrottleSchedule)(_requestDocument.returnDocumentRequestNoThrowError);
   return {
     name: 'core',
     getSharedState: function getSharedState(state) {
@@ -122,17 +123,26 @@ var corePlugin = exports.corePlugin = function corePlugin(_ref) {
         var view = (_config$getEditorView = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView !== void 0 ? _config$getEditorView : null;
         scheduleDocumentRequest(view, onReceive, options === null || options === void 0 ? void 0 : options.transformer, config === null || config === void 0 ? void 0 : config.fireAnalyticsEvent, options === null || options === void 0 ? void 0 : options.alwaysFire);
       },
+      requestDocumentAsync: function requestDocumentAsync(options) {
+        return new Promise(function (resolve) {
+          var _config$getEditorView2;
+          var view = (_config$getEditorView2 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView2 !== void 0 ? _config$getEditorView2 : null;
+          scheduleDocumentRequestNoThrowError(view, function (doc) {
+            resolve(doc);
+          }, options === null || options === void 0 ? void 0 : options.transformer, config === null || config === void 0 ? void 0 : config.fireAnalyticsEvent, true);
+        });
+      },
       createTransformer: function createTransformer(cb) {
-        var _config$getEditorView2;
-        var view = (_config$getEditorView2 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView2 !== void 0 ? _config$getEditorView2 : null;
+        var _config$getEditorView3;
+        var view = (_config$getEditorView3 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView3 !== void 0 ? _config$getEditorView3 : null;
         if (!(view !== null && view !== void 0 && view.state.schema)) {
           return undefined;
         }
         return cb(view === null || view === void 0 ? void 0 : view.state.schema);
       },
       getAnchorIdForNode: function getAnchorIdForNode(node, pos) {
-        var _config$getEditorView3;
-        var view = (_config$getEditorView3 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView3 !== void 0 ? _config$getEditorView3 : null;
+        var _config$getEditorView4;
+        var view = (_config$getEditorView4 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView4 !== void 0 ? _config$getEditorView4 : null;
         if (!view) {
           return undefined;
         }

package/dist/cjs/preset/core-plugin/requestDocument.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createThrottleSchedule = createThrottleSchedule;
 exports.returnDocumentRequest = returnDocumentRequest;
+exports.returnDocumentRequestNoThrowError = returnDocumentRequestNoThrowError;
 exports.toJSON = toJSON;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
@@ -69,7 +70,9 @@ function createThrottleSchedule(callback) {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire) {
+function returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent,
+// eslint-disable-next-line no-unused-vars
+_alwaysFire) {
   var _editorView$state;
   var _ref = (_editorView$state = editorView === null || editorView === void 0 ? void 0 : editorView.state) !== null && _editorView$state !== void 0 ? _editorView$state : {},
     doc = _ref.doc,
@@ -98,4 +101,12 @@ function returnDocumentRequest(editorView, callback, transformer, fireAnalyticsE
     });
     throw e;
   }
+}
+function returnDocumentRequestNoThrowError(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire) {
+  try {
+    return returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire);
+    // eslint-disable-next-line no-unused-vars
+  } catch (_) {
+    callback(undefined);
+  }
 }

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

@@ -24,7 +24,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 = "110.36.7";
+var packageVersion = "110.36.8";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/monitoring/error.js

@@ -4,7 +4,7 @@ import { isFedRamp } from './environment';
 import { normaliseSentryBreadcrumbs, SERIALIZABLE_ATTRIBUTES } from './normalise-sentry-breadcrumbs';
 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 = "110.36.7";
+const packageVersion = "110.36.8";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/preset/core-plugin/index.js

@@ -3,7 +3,7 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import { getNodeIdProvider } from '../../node-anchor/node-anchor-provider';
 import { processRawFragmentValue, processRawValue, processRawValueWithoutValidation } from '../../utils/processRawValue';
 import { editorCommandToPMCommand } from '../editor-commands';
-import { createThrottleSchedule, returnDocumentRequest } from './requestDocument';
+import { createThrottleSchedule, returnDocumentRequest, returnDocumentRequestNoThrowError } from './requestDocument';
 
 /**
  * Core plugin that is always included in the preset.
@@ -14,6 +14,7 @@ export const corePlugin = ({
 }) => {
   // Create the document request throttler per editor (rather than at a module level)
   const scheduleDocumentRequest = createThrottleSchedule(returnDocumentRequest);
+  const scheduleDocumentRequestNoThrowError = createThrottleSchedule(returnDocumentRequestNoThrowError);
   return {
     name: 'core',
     getSharedState(state) {
@@ -124,17 +125,26 @@ export const corePlugin = ({
         const view = (_config$getEditorView = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView !== void 0 ? _config$getEditorView : null;
         scheduleDocumentRequest(view, onReceive, options === null || options === void 0 ? void 0 : options.transformer, config === null || config === void 0 ? void 0 : config.fireAnalyticsEvent, options === null || options === void 0 ? void 0 : options.alwaysFire);
       },
+      requestDocumentAsync: options => {
+        return new Promise(resolve => {
+          var _config$getEditorView2;
+          const view = (_config$getEditorView2 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView2 !== void 0 ? _config$getEditorView2 : null;
+          scheduleDocumentRequestNoThrowError(view, doc => {
+            resolve(doc);
+          }, options === null || options === void 0 ? void 0 : options.transformer, config === null || config === void 0 ? void 0 : config.fireAnalyticsEvent, true);
+        });
+      },
       createTransformer(cb) {
-        var _config$getEditorView2;
-        const view = (_config$getEditorView2 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView2 !== void 0 ? _config$getEditorView2 : null;
+        var _config$getEditorView3;
+        const view = (_config$getEditorView3 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView3 !== void 0 ? _config$getEditorView3 : null;
         if (!(view !== null && view !== void 0 && view.state.schema)) {
           return undefined;
         }
         return cb(view === null || view === void 0 ? void 0 : view.state.schema);
       },
       getAnchorIdForNode(node, pos) {
-        var _config$getEditorView3;
-        const view = (_config$getEditorView3 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView3 !== void 0 ? _config$getEditorView3 : null;
+        var _config$getEditorView4;
+        const view = (_config$getEditorView4 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView4 !== void 0 ? _config$getEditorView4 : null;
         if (!view) {
           return undefined;
         }

package/dist/es2019/preset/core-plugin/requestDocument.js

@@ -50,7 +50,9 @@ export function createThrottleSchedule(callback) {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire) {
+export function returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent,
+// eslint-disable-next-line no-unused-vars
+_alwaysFire) {
   var _editorView$state;
   const {
     doc,
@@ -80,4 +82,12 @@ export function returnDocumentRequest(editorView, callback, transformer, fireAna
     });
     throw e;
   }
+}
+export function returnDocumentRequestNoThrowError(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire) {
+  try {
+    return returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire);
+    // eslint-disable-next-line no-unused-vars
+  } catch (_) {
+    callback(undefined);
+  }
 }

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

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "110.36.7";
+const packageVersion = "110.36.8";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/monitoring/error.js

@@ -10,7 +10,7 @@ import { isFedRamp } from './environment';
 import { normaliseSentryBreadcrumbs, SERIALIZABLE_ATTRIBUTES } from './normalise-sentry-breadcrumbs';
 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 = "110.36.7";
+var packageVersion = "110.36.8";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/preset/core-plugin/index.js

@@ -3,7 +3,7 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import { getNodeIdProvider } from '../../node-anchor/node-anchor-provider';
 import { processRawFragmentValue, processRawValue, processRawValueWithoutValidation } from '../../utils/processRawValue';
 import { editorCommandToPMCommand } from '../editor-commands';
-import { createThrottleSchedule, returnDocumentRequest } from './requestDocument';
+import { createThrottleSchedule, returnDocumentRequest, returnDocumentRequestNoThrowError } from './requestDocument';
 
 /**
  * Core plugin that is always included in the preset.
@@ -13,6 +13,7 @@ export var corePlugin = function corePlugin(_ref) {
   var config = _ref.config;
   // Create the document request throttler per editor (rather than at a module level)
   var scheduleDocumentRequest = createThrottleSchedule(returnDocumentRequest);
+  var scheduleDocumentRequestNoThrowError = createThrottleSchedule(returnDocumentRequestNoThrowError);
   return {
     name: 'core',
     getSharedState: function getSharedState(state) {
@@ -117,17 +118,26 @@ export var corePlugin = function corePlugin(_ref) {
         var view = (_config$getEditorView = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView !== void 0 ? _config$getEditorView : null;
         scheduleDocumentRequest(view, onReceive, options === null || options === void 0 ? void 0 : options.transformer, config === null || config === void 0 ? void 0 : config.fireAnalyticsEvent, options === null || options === void 0 ? void 0 : options.alwaysFire);
       },
+      requestDocumentAsync: function requestDocumentAsync(options) {
+        return new Promise(function (resolve) {
+          var _config$getEditorView2;
+          var view = (_config$getEditorView2 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView2 !== void 0 ? _config$getEditorView2 : null;
+          scheduleDocumentRequestNoThrowError(view, function (doc) {
+            resolve(doc);
+          }, options === null || options === void 0 ? void 0 : options.transformer, config === null || config === void 0 ? void 0 : config.fireAnalyticsEvent, true);
+        });
+      },
       createTransformer: function createTransformer(cb) {
-        var _config$getEditorView2;
-        var view = (_config$getEditorView2 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView2 !== void 0 ? _config$getEditorView2 : null;
+        var _config$getEditorView3;
+        var view = (_config$getEditorView3 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView3 !== void 0 ? _config$getEditorView3 : null;
         if (!(view !== null && view !== void 0 && view.state.schema)) {
           return undefined;
         }
         return cb(view === null || view === void 0 ? void 0 : view.state.schema);
       },
       getAnchorIdForNode: function getAnchorIdForNode(node, pos) {
-        var _config$getEditorView3;
-        var view = (_config$getEditorView3 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView3 !== void 0 ? _config$getEditorView3 : null;
+        var _config$getEditorView4;
+        var view = (_config$getEditorView4 = config === null || config === void 0 ? void 0 : config.getEditorView()) !== null && _config$getEditorView4 !== void 0 ? _config$getEditorView4 : null;
         if (!view) {
           return undefined;
         }

package/dist/esm/preset/core-plugin/requestDocument.js

@@ -60,7 +60,9 @@ export function createThrottleSchedule(callback) {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire) {
+export function returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent,
+// eslint-disable-next-line no-unused-vars
+_alwaysFire) {
   var _editorView$state;
   var _ref = (_editorView$state = editorView === null || editorView === void 0 ? void 0 : editorView.state) !== null && _editorView$state !== void 0 ? _editorView$state : {},
     doc = _ref.doc,
@@ -89,4 +91,12 @@ export function returnDocumentRequest(editorView, callback, transformer, fireAna
     });
     throw e;
   }
+}
+export function returnDocumentRequestNoThrowError(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire) {
+  try {
+    return returnDocumentRequest(editorView, callback, transformer, fireAnalyticsEvent, _alwaysFire);
+    // eslint-disable-next-line no-unused-vars
+  } catch (_) {
+    callback(undefined);
+  }
 }

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

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "110.36.7";
+var packageVersion = "110.36.8";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/preset/core-plugin/requestDocument.d.ts

@@ -9,3 +9,4 @@ export declare function toJSON(node: PMNode): JSONDocNode;
  */
 export declare function createThrottleSchedule<GenericTransformer extends Transformer<any> = Transformer<JSONDocNode>>(callback: typeof returnDocumentRequest<GenericTransformer>): (editorView: EditorView | null, callback: GenericTransformer extends undefined ? DefaultTransformerResultCallback : InferTransformerResultCallback<GenericTransformer>, transformer?: GenericTransformer | undefined, fireAnalyticsEvent?: FireAnalyticsCallback | undefined, _alwaysFire?: boolean | undefined) => void;
 export declare function returnDocumentRequest<GenericTransformer extends Transformer<any> | undefined>(editorView: EditorView | null, callback: GenericTransformer extends undefined ? DefaultTransformerResultCallback : InferTransformerResultCallback<GenericTransformer>, transformer?: GenericTransformer, fireAnalyticsEvent?: FireAnalyticsCallback, _alwaysFire?: boolean): undefined;
+export declare function returnDocumentRequestNoThrowError<GenericTransformer extends Transformer<any> | undefined>(editorView: EditorView | null, callback: GenericTransformer extends undefined ? DefaultTransformerResultCallback : InferTransformerResultCallback<GenericTransformer>, transformer?: GenericTransformer, fireAnalyticsEvent?: FireAnalyticsCallback, _alwaysFire?: boolean): undefined;

package/dist/types/types/next-editor-plugin.d.ts

@@ -92,6 +92,19 @@ export type CorePlugin = NextEditorPlugin<'core', {
             alwaysFire?: boolean;
             transformer?: GenericTransformer;
         }): void;
+        /**
+         * Request the editor document asynchronously.
+         *
+         * A transformer can be created using `createTransformer`.
+         *
+         * @param options Options for document request
+         * @param options.transformer Pass a transformer for the document to be transformed into a different format.
+         *
+         * @returns (Promise) Promise that resolves to the document. Document type based on the transformer.
+         */
+        requestDocumentAsync: <GenericTransformer extends Transformer<any> = Transformer<JSONDocNode>>(options?: {
+            transformer?: GenericTransformer;
+        }) => Promise<TransformerResult<GenericTransformer> | undefined>;
         /**
          * Scroll to a specific position in the editor using native Element.scrollIntoView
          *

package/dist/types-ts4.5/preset/core-plugin/requestDocument.d.ts

@@ -9,3 +9,4 @@ export declare function toJSON(node: PMNode): JSONDocNode;
  */
 export declare function createThrottleSchedule<GenericTransformer extends Transformer<any> = Transformer<JSONDocNode>>(callback: typeof returnDocumentRequest<GenericTransformer>): (editorView: EditorView | null, callback: GenericTransformer extends undefined ? DefaultTransformerResultCallback : InferTransformerResultCallback<GenericTransformer>, transformer?: GenericTransformer | undefined, fireAnalyticsEvent?: FireAnalyticsCallback | undefined, _alwaysFire?: boolean | undefined) => void;
 export declare function returnDocumentRequest<GenericTransformer extends Transformer<any> | undefined>(editorView: EditorView | null, callback: GenericTransformer extends undefined ? DefaultTransformerResultCallback : InferTransformerResultCallback<GenericTransformer>, transformer?: GenericTransformer, fireAnalyticsEvent?: FireAnalyticsCallback, _alwaysFire?: boolean): undefined;
+export declare function returnDocumentRequestNoThrowError<GenericTransformer extends Transformer<any> | undefined>(editorView: EditorView | null, callback: GenericTransformer extends undefined ? DefaultTransformerResultCallback : InferTransformerResultCallback<GenericTransformer>, transformer?: GenericTransformer, fireAnalyticsEvent?: FireAnalyticsCallback, _alwaysFire?: boolean): undefined;

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

@@ -92,6 +92,19 @@ export type CorePlugin = NextEditorPlugin<'core', {
             alwaysFire?: boolean;
             transformer?: GenericTransformer;
         }): void;
+        /**
+         * Request the editor document asynchronously.
+         *
+         * A transformer can be created using `createTransformer`.
+         *
+         * @param options Options for document request
+         * @param options.transformer Pass a transformer for the document to be transformed into a different format.
+         *
+         * @returns (Promise) Promise that resolves to the document. Document type based on the transformer.
+         */
+        requestDocumentAsync: <GenericTransformer extends Transformer<any> = Transformer<JSONDocNode>>(options?: {
+            transformer?: GenericTransformer;
+        }) => Promise<TransformerResult<GenericTransformer> | undefined>;
         /**
          * Scroll to a specific position in the editor using native Element.scrollIntoView
          *

package/package.json

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