@atlaskit/editor-common 87.0.3 → 87.0.4

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-common
 
+## 87.0.4
+
+### Patch Changes
+
+- [#125133](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/125133)
+  [`d804e5dd3216b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/d804e5dd3216b) -
+  ED-24226 - Add state to manage the toggle word wrap state of code blocks. New WeakMap added in
+  editor-common/src/code-block, as word wrap state is shared throughout the editor. Covers regular
+  changes to code block by the user via the node view update function. Covers breakout of code block
+  node. Does not cover drag&drop & cut&paste edge cases.
+
 ## 87.0.3
 
 ### Patch Changes

package/code-block/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/editor-common/code-block",
+  "main": "../dist/cjs/code-block/index.js",
+  "module": "../dist/esm/code-block/index.js",
+  "module:es2019": "../dist/es2019/code-block/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/code-block/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/code-block/index.d.ts"
+      ]
+    }
+  }
+}

package/dist/cjs/code-block/index.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.transferCodeBlockWrappedValue = exports.isCodeBlockWordWrapEnabled = exports.defaultWordWrapState = exports.codeBlockWrappedStates = void 0;
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var defaultWordWrapState = exports.defaultWordWrapState = false;
+var codeBlockWrappedStates = exports.codeBlockWrappedStates = new WeakMap();
+var isCodeBlockWordWrapEnabled = exports.isCodeBlockWordWrapEnabled = function isCodeBlockWordWrapEnabled(codeBlockNode) {
+  if (!(0, _platformFeatureFlags.fg)('editor_support_code_block_wrapping')) {
+    return false;
+  }
+  var currentNodeWordWrapState = codeBlockWrappedStates.get(codeBlockNode);
+  return currentNodeWordWrapState !== undefined ? currentNodeWordWrapState : defaultWordWrapState;
+};
+
+/**
+ * As the code block node is used as the key, there is instances where the node will be destroyed & recreated and is no longer a valid key.
+ * In these instances, we must get the value from that old node and set it to the value of the new node.
+ */
+var transferCodeBlockWrappedValue = exports.transferCodeBlockWrappedValue = function transferCodeBlockWrappedValue(oldCodeBlockNode, newCodeBlockNode) {
+  if (!(0, _platformFeatureFlags.fg)('editor_support_code_block_wrapping')) {
+    return;
+  }
+  var previousValue = codeBlockWrappedStates.get(oldCodeBlockNode);
+  if (previousValue !== undefined) {
+    codeBlockWrappedStates.set(newCodeBlockNode, previousValue);
+    codeBlockWrappedStates.delete(oldCodeBlockNode);
+  }
+};

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 && Object.prototype.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 = "87.0.3";
+var packageVersion = "87.0.4";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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 = "87.0.3";
+var packageVersion = "87.0.4";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/es2019/code-block/index.js

@@ -0,0 +1,25 @@
+import { fg } from '@atlaskit/platform-feature-flags';
+export const defaultWordWrapState = false;
+export const codeBlockWrappedStates = new WeakMap();
+export const isCodeBlockWordWrapEnabled = codeBlockNode => {
+  if (!fg('editor_support_code_block_wrapping')) {
+    return false;
+  }
+  const currentNodeWordWrapState = codeBlockWrappedStates.get(codeBlockNode);
+  return currentNodeWordWrapState !== undefined ? currentNodeWordWrapState : defaultWordWrapState;
+};
+
+/**
+ * As the code block node is used as the key, there is instances where the node will be destroyed & recreated and is no longer a valid key.
+ * In these instances, we must get the value from that old node and set it to the value of the new node.
+ */
+export const transferCodeBlockWrappedValue = (oldCodeBlockNode, newCodeBlockNode) => {
+  if (!fg('editor_support_code_block_wrapping')) {
+    return;
+  }
+  const previousValue = codeBlockWrappedStates.get(oldCodeBlockNode);
+  if (previousValue !== undefined) {
+    codeBlockWrappedStates.set(newCodeBlockNode, previousValue);
+    codeBlockWrappedStates.delete(oldCodeBlockNode);
+  }
+};

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 = "87.0.3";
+const packageVersion = "87.0.4";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -12,7 +12,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import { N0, N50A, N60A, N900 } from '@atlaskit/theme/colors';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "87.0.3";
+const packageVersion = "87.0.4";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

package/dist/esm/code-block/index.js

@@ -0,0 +1,25 @@
+import { fg } from '@atlaskit/platform-feature-flags';
+export var defaultWordWrapState = false;
+export var codeBlockWrappedStates = new WeakMap();
+export var isCodeBlockWordWrapEnabled = function isCodeBlockWordWrapEnabled(codeBlockNode) {
+  if (!fg('editor_support_code_block_wrapping')) {
+    return false;
+  }
+  var currentNodeWordWrapState = codeBlockWrappedStates.get(codeBlockNode);
+  return currentNodeWordWrapState !== undefined ? currentNodeWordWrapState : defaultWordWrapState;
+};
+
+/**
+ * As the code block node is used as the key, there is instances where the node will be destroyed & recreated and is no longer a valid key.
+ * In these instances, we must get the value from that old node and set it to the value of the new node.
+ */
+export var transferCodeBlockWrappedValue = function transferCodeBlockWrappedValue(oldCodeBlockNode, newCodeBlockNode) {
+  if (!fg('editor_support_code_block_wrapping')) {
+    return;
+  }
+  var previousValue = codeBlockWrappedStates.get(oldCodeBlockNode);
+  if (previousValue !== undefined) {
+    codeBlockWrappedStates.set(newCodeBlockNode, previousValue);
+    codeBlockWrappedStates.delete(oldCodeBlockNode);
+  }
+};

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 = "87.0.3";
+var packageVersion = "87.0.4";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -20,7 +20,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import { N0, N50A, N60A, N900 } from '@atlaskit/theme/colors';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "87.0.3";
+var packageVersion = "87.0.4";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/types/code-block/index.d.ts

@@ -0,0 +1,9 @@
+import type { Node as PmNode } from '@atlaskit/editor-prosemirror/model';
+export declare const defaultWordWrapState = false;
+export declare const codeBlockWrappedStates: WeakMap<PmNode, boolean | undefined>;
+export declare const isCodeBlockWordWrapEnabled: (codeBlockNode: PmNode) => boolean;
+/**
+ * As the code block node is used as the key, there is instances where the node will be destroyed & recreated and is no longer a valid key.
+ * In these instances, we must get the value from that old node and set it to the value of the new node.
+ */
+export declare const transferCodeBlockWrappedValue: (oldCodeBlockNode: PmNode, newCodeBlockNode: PmNode) => void;

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

@@ -0,0 +1,9 @@
+import type { Node as PmNode } from '@atlaskit/editor-prosemirror/model';
+export declare const defaultWordWrapState = false;
+export declare const codeBlockWrappedStates: WeakMap<PmNode, boolean | undefined>;
+export declare const isCodeBlockWordWrapEnabled: (codeBlockNode: PmNode) => boolean;
+/**
+ * As the code block node is used as the key, there is instances where the node will be destroyed & recreated and is no longer a valid key.
+ * In these instances, we must get the value from that old node and set it to the value of the new node.
+ */
+export declare const transferCodeBlockWrappedValue: (oldCodeBlockNode: PmNode, newCodeBlockNode: PmNode) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "87.0.3",
+	"version": "87.0.4",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -93,6 +93,7 @@
 		"./constants": "./src/link/constants.ts",
 		"./doc-utils": "./src/doc-utils/index.ts",
 		"./expand": "./src/expand/index.ts",
+		"./code-block": "./src/code-block/index.ts",
 		"./table": "./src/table/index.ts",
 		"./lazy-node-view": "./src/lazy-node-view/index.ts"
 	},
@@ -264,6 +265,9 @@
 		},
 		"editor_inline_comments_paste_insert_nodes": {
 			"type": "boolean"
+		},
+		"editor_support_code_block_wrapping": {
+			"type": "boolean"
 		}
 	}
 }