@atlaskit/editor-core 179.0.3 → 179.0.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-core
 
+## 179.0.4
+
+### Patch Changes
+
+- [`5139cd8cbdf`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5139cd8cbdf) - [ED-16854] Add @deprecate annotations to public class methods in editor.
+
 ## 179.0.3
 
 ### Patch Changes

package/dist/cjs/editor.js

@@ -180,6 +180,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
         });
       }
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an anti-pattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "trackEditorActions",
     value: function trackEditorActions(editorActions, props) {
@@ -266,9 +273,23 @@ var Editor = /*#__PURE__*/function (_React$Component) {
       }
       return editorActions;
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "onEditorCreated",
-    value: function onEditorCreated(instance) {
+    value:
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
+    function onEditorCreated(instance) {
       var _this$props$featureFl2;
       this.registerEditorForActions(instance.view, instance.eventDispatcher, instance.transformer);
       if ((_this$props$featureFl2 = this.props.featureFlags) !== null && _this$props$featureFl2 !== void 0 && _this$props$featureFl2.ufo) {
@@ -372,6 +393,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
         console.warn("\"allowMoreTextColors\" field of \"allowTextColor\" property is deprecated. It will be removedin editor-core@".concat(nextVersion, ". The color palette now shows more colors by default."));
       }
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "onEditorDestroyed",
     value: function onEditorDestroyed(_instance) {
@@ -443,6 +471,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
     value: function getBaseFontSize() {
       return !['comment', 'chromeless', 'mobile'].includes(this.props.appearance) ? _editorSharedStyles.akEditorFullPageDefaultFontSize : undefined;
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "render",
     value: function render() {

package/dist/cjs/test-utils.js

@@ -42,6 +42,7 @@ Object.defineProperty(exports, "createTypeAheadTools", {
   }
 });
 exports.getFireAnalytics = getFireAnalytics;
+exports.isElementBySelectorInDocument = void 0;
 exports.setTextSelection = setTextSelection;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
@@ -134,4 +135,15 @@ function setTextSelection(view, anchor, head) {
   var state = view.state;
   var tr = state.tr.setSelection(_prosemirrorState.TextSelection.create(state.doc, anchor, head));
   view.dispatch(tr);
-}
+}
+
+/**
+ * Given a selector, checks if an element matching the selector exists in the
+ * document.
+ * @param selector
+ * @returns true if element matching selector exists in document, false otherwise
+ */
+var isElementBySelectorInDocument = function isElementBySelectorInDocument(selector) {
+  return Boolean(document.querySelector(selector));
+};
+exports.isElementBySelectorInDocument = isElementBySelectorInDocument;

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/editor-core";
 exports.name = name;
-var version = "179.0.3";
+var version = "179.0.4";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "179.0.3",
+	"version": "179.0.4",
 	"sideEffects": false
 }

package/dist/es2019/editor.js

@@ -148,6 +148,13 @@ export default class Editor extends React.Component {
       });
     }
   }
+
+  /**
+   * @private
+   * @deprecated - Do not override this at all, this is an anti-pattern.
+   * Please reach out to the Editor team if you were previously using this
+   * and need to find a workaround.
+   */
   trackEditorActions(editorActions, props) {
     var _props$performanceTra9, _props$performanceTra10;
     if (props !== null && props !== void 0 && (_props$performanceTra9 = props.performanceTracking) !== null && _props$performanceTra9 !== void 0 && (_props$performanceTra10 = _props$performanceTra9.contentRetrievalTracking) !== null && _props$performanceTra10 !== void 0 && _props$performanceTra10.enabled) {
@@ -216,6 +223,20 @@ export default class Editor extends React.Component {
     }
     return editorActions;
   }
+
+  /**
+   * @private
+   * @deprecated - Do not override this at all, this is an antipattern.
+   * Please reach out to the Editor team if you were previously using this
+   * and need to find a workaround.
+   */
+
+  /**
+   * @private
+   * @deprecated - Do not override this at all, this is an antipattern.
+   * Please reach out to the Editor team if you were previously using this
+   * and need to find a workaround.
+   */
   onEditorCreated(instance) {
     var _this$props$featureFl2;
     this.registerEditorForActions(instance.view, instance.eventDispatcher, instance.transformer);
@@ -297,6 +318,13 @@ export default class Editor extends React.Component {
       console.warn(`"allowMoreTextColors" field of "allowTextColor" property is deprecated. It will be removedin editor-core@${nextVersion}. The color palette now shows more colors by default.`);
     }
   }
+
+  /**
+   * @private
+   * @deprecated - Do not override this at all, this is an antipattern.
+   * Please reach out to the Editor team if you were previously using this
+   * and need to find a workaround.
+   */
   onEditorDestroyed(_instance) {
     this.unregisterEditorFromActions();
     if (this.props.onDestroy) {
@@ -361,6 +389,14 @@ export default class Editor extends React.Component {
   getBaseFontSize() {
     return !['comment', 'chromeless', 'mobile'].includes(this.props.appearance) ? akEditorFullPageDefaultFontSize : undefined;
   }
+
+  /**
+   * @private
+   * @deprecated - Do not override this at all, this is an antipattern.
+   * Please reach out to the Editor team if you were previously using this
+   * and need to find a workaround.
+   */
+
   render() {
     var _this$props$performan3, _this$props$performan4;
     const Component = getUiComponent(this.props.appearance);

package/dist/es2019/test-utils.js

@@ -79,4 +79,14 @@ export function setTextSelection(view, anchor, head) {
   } = view;
   const tr = state.tr.setSelection(TextSelection.create(state.doc, anchor, head));
   view.dispatch(tr);
-}
+}
+
+/**
+ * Given a selector, checks if an element matching the selector exists in the
+ * document.
+ * @param selector
+ * @returns true if element matching selector exists in document, false otherwise
+ */
+export const isElementBySelectorInDocument = selector => {
+  return Boolean(document.querySelector(selector));
+};

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/editor-core";
-export const version = "179.0.3";
+export const version = "179.0.4";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "179.0.3",
+	"version": "179.0.4",
 	"sideEffects": false
 }

package/dist/esm/editor.js

@@ -173,6 +173,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
         });
       }
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an anti-pattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "trackEditorActions",
     value: function trackEditorActions(editorActions, props) {
@@ -259,9 +266,23 @@ var Editor = /*#__PURE__*/function (_React$Component) {
       }
       return editorActions;
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "onEditorCreated",
-    value: function onEditorCreated(instance) {
+    value:
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
+    function onEditorCreated(instance) {
       var _this$props$featureFl2;
       this.registerEditorForActions(instance.view, instance.eventDispatcher, instance.transformer);
       if ((_this$props$featureFl2 = this.props.featureFlags) !== null && _this$props$featureFl2 !== void 0 && _this$props$featureFl2.ufo) {
@@ -365,6 +386,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
         console.warn("\"allowMoreTextColors\" field of \"allowTextColor\" property is deprecated. It will be removedin editor-core@".concat(nextVersion, ". The color palette now shows more colors by default."));
       }
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "onEditorDestroyed",
     value: function onEditorDestroyed(_instance) {
@@ -436,6 +464,13 @@ var Editor = /*#__PURE__*/function (_React$Component) {
     value: function getBaseFontSize() {
       return !['comment', 'chromeless', 'mobile'].includes(this.props.appearance) ? akEditorFullPageDefaultFontSize : undefined;
     }
+
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
   }, {
     key: "render",
     value: function render() {

package/dist/esm/test-utils.js

@@ -89,4 +89,14 @@ export function setTextSelection(view, anchor, head) {
   var state = view.state;
   var tr = state.tr.setSelection(TextSelection.create(state.doc, anchor, head));
   view.dispatch(tr);
-}
+}
+
+/**
+ * Given a selector, checks if an element matching the selector exists in the
+ * document.
+ * @param selector
+ * @returns true if element matching selector exists in document, false otherwise
+ */
+export var isElementBySelectorInDocument = function isElementBySelectorInDocument(selector) {
+  return Boolean(document.querySelector(selector));
+};

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/editor-core";
-export var version = "179.0.3";
+export var version = "179.0.4";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "179.0.3",
+	"version": "179.0.4",
 	"sideEffects": false
 }

package/dist/types/editor.d.ts

@@ -38,6 +38,12 @@ export default class Editor extends React.Component<EditorProps, State> {
     componentDidMount(): void;
     componentDidUpdate(prevProps: EditorProps): void;
     componentWillUnmount(): void;
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an anti-pattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
     trackEditorActions(editorActions: EditorActions & {
         _contentRetrievalTracking?: {
             getValueTracked: boolean;
@@ -55,8 +61,26 @@ export default class Editor extends React.Component<EditorProps, State> {
             };
         } | undefined;
     };
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
     prepareExtensionProvider: import("memoize-one").MemoizedFn<(extensionProviders?: ExtensionProvidersProp | undefined) => ExtensionProvider<any> | undefined>;
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
     prepareQuickInsertProvider: (extensionProvider?: ExtensionProvider<any> | undefined, quickInsert?: QuickInsertOptions | undefined) => Promise<QuickInsertProvider> | undefined;
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
     onEditorCreated(instance: {
         view: EditorView;
         eventDispatcher: EventDispatcher;
@@ -64,6 +88,12 @@ export default class Editor extends React.Component<EditorProps, State> {
     }): void;
     private sendDurationAnalytics;
     private deprecationWarnings;
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
     onEditorDestroyed(_instance: {
         view: EditorView;
         transformer?: Transformer<string>;
@@ -72,7 +102,19 @@ export default class Editor extends React.Component<EditorProps, State> {
     private unregisterEditorFromActions;
     private handleProviders;
     private getBaseFontSize;
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
     handleSave: (view: EditorView) => void;
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
     handleAnalyticsEvent: FireAnalyticsCallback;
     render(): jsx.JSX.Element;
 }

package/dist/types/test-utils.d.ts

@@ -28,3 +28,10 @@ export { EventDispatcher } from './event-dispatcher';
 export type { Dispatch } from './event-dispatcher';
 export { GapCursorSelection, Side as GapCursorSide, } from './plugins/selection/gap-cursor/selection';
 export declare function setTextSelection(view: EditorView, anchor: number, head?: number): void;
+/**
+ * Given a selector, checks if an element matching the selector exists in the
+ * document.
+ * @param selector
+ * @returns true if element matching selector exists in document, false otherwise
+ */
+export declare const isElementBySelectorInDocument: (selector: string) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-core",
-  "version": "179.0.3",
+  "version": "179.0.4",
   "description": "A package contains Atlassian editor core functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"