@atlaskit/editor-plugin-limited-mode 3.0.4 → 3.1.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/editor-plugin-limited-mode
 
+## 3.1.1
+
+### Patch Changes
+
+- [`4d676bbdb3ce6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4d676bbdb3ce6) -
+  ts-ignore added temporarily to unblock local consumption for help-center, will be removed once
+  project refs are setup
+- Updated dependencies
+
+## 3.1.0
+
+### Minor Changes
+
+- [`c6c113481c118`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c6c113481c118) -
+  Updates limited mode to include lcm sizes in decision to engage.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.0.4
 
 ### Patch Changes

package/afm-jira/tsconfig.json

@@ -2,7 +2,7 @@
 	"extends": "../../../../tsconfig.entry-points.jira.json",
 	"compilerOptions": {
 		"target": "es5",
-		"outDir": "../../../../../tsDist/@atlaskit__editor-plugin-limited-mode/app",
+		"outDir": "../../../../../jira/tsDist/@atlaskit__editor-plugin-limited-mode/app",
 		"rootDir": "../",
 		"composite": true
 	},

package/afm-products/tsconfig.json

@@ -0,0 +1,30 @@
+{
+	"extends": "../../../../tsconfig.entry-points.products.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../tsDist/@atlaskit__editor-plugin-limited-mode/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../../design-system/primitives/afm-products/tsconfig.json"
+		},
+		{
+			"path": "../../tmp-editor-statsig/afm-products/tsconfig.json"
+		},
+		{
+			"path": "../../editor-common/afm-products/tsconfig.json"
+		}
+	]
+}

package/dist/cjs/limitedModePlugin.js

@@ -54,6 +54,10 @@ var limitedModePlugin = exports.limitedModePlugin = function limitedModePlugin(_
         // eslint-disable-next-line react-hooks/exhaustive-deps
       }, [options.contentId]);
       var checkAndShowFlag = (0, _react.useCallback)(function (isLimitedModeEnabled) {
+        if (!((0, _expVal.expVal)('cc_editor_limited_mode', 'flagEnabled', true) === true)) {
+          // Disable the flag behavior entirely if the flag is off
+          return;
+        }
         var _learnMoreLink = (0, _expVal.expVal)('cc_editor_limited_mode', 'learnMoreLink', '');
         if (isLimitedModeEnabled && hasEditorBeenFocusedRef.current && !hasShownFlagRef.current) {
           var _options$showFlag;

package/dist/cjs/pm-plugins/main.js

@@ -15,34 +15,77 @@ var limitedModePluginKey = exports.limitedModePluginKey = new _state.PluginKey('
 var createPlugin = exports.createPlugin = function createPlugin() {
   return new _safePlugin.SafePlugin({
     key: limitedModePluginKey,
+    // @ts-ignore - Workaround for help-center local consumption
+
     view: function view(_view) {
       return {};
     },
     state: {
+      // @ts-ignore - Workaround for help-center local consumption
       init: function init(config, editorState) {
-        if (editorState.doc.nodeSize > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if ((0, _expVal.expVal)('cc_editor_limited_mode_include_lcm', 'isEnabled', true)) {
+          // calculates the size of the doc, where when there are legacy content macros, the content
+          // is stored in the attrs.
+          // This is essentiall doc.nod
+          var customDocSize = editorState.doc.nodeSize;
+          // @ts-ignore - Workaround for help-center local consumption
+
+          editorState.doc.descendants(function (node) {
+            var _node$attrs;
+            if (((_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.extensionKey) === 'legacy-content') {
+              var _node$attrs$parameter, _node$attrs2;
+              customDocSize += (_node$attrs$parameter = (_node$attrs2 = node.attrs) === null || _node$attrs2 === void 0 || (_node$attrs2 = _node$attrs2.parameters) === null || _node$attrs2 === void 0 || (_node$attrs2 = _node$attrs2.adf) === null || _node$attrs2 === void 0 ? void 0 : _node$attrs2.length) !== null && _node$attrs$parameter !== void 0 ? _node$attrs$parameter : 0;
+            }
+          });
+          return {
+            documentSizeBreachesThreshold: customDocSize > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)
+          };
+        } else {
+          if (editorState.doc.nodeSize > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)) {
+            return {
+              documentSizeBreachesThreshold: true
+            };
+          }
           return {
-            documentSizeBreachesThreshold: true
+            documentSizeBreachesThreshold: false
           };
         }
-        return {
-          documentSizeBreachesThreshold: false
-        };
       },
+      // @ts-ignore - Workaround for help-center local consumption
+
       apply: function apply(tr, currentPluginState) {
         // Don't check the document size if we're already in limited mode.
         // We ALWAYS want to re-check the document size if we're replacing the document (e.g. live-to-live page navigation).
         if (currentPluginState.documentSizeBreachesThreshold && !tr.getMeta('replaceDocument')) {
           return currentPluginState;
         }
-        if (tr.doc.nodeSize > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if ((0, _expVal.expVal)('cc_editor_limited_mode_include_lcm', 'isEnabled', true)) {
+          // calculates the size of the doc, where when there are legacy content macros, the content
+          // is stored in the attrs.
+          // This is essentiall doc.nod
+          var customDocSize = tr.doc.nodeSize;
+          // @ts-ignore - Workaround for help-center local consumption
+
+          tr.doc.descendants(function (node) {
+            var _node$attrs3;
+            if (((_node$attrs3 = node.attrs) === null || _node$attrs3 === void 0 ? void 0 : _node$attrs3.extensionKey) === 'legacy-content') {
+              var _node$attrs$parameter2, _node$attrs4;
+              customDocSize += (_node$attrs$parameter2 = (_node$attrs4 = node.attrs) === null || _node$attrs4 === void 0 || (_node$attrs4 = _node$attrs4.parameters) === null || _node$attrs4 === void 0 || (_node$attrs4 = _node$attrs4.adf) === null || _node$attrs4 === void 0 ? void 0 : _node$attrs4.length) !== null && _node$attrs$parameter2 !== void 0 ? _node$attrs$parameter2 : 0;
+            }
+          });
+          return {
+            documentSizeBreachesThreshold: customDocSize > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)
+          };
+        } else {
+          if (tr.doc.nodeSize > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)) {
+            return _objectSpread(_objectSpread({}, currentPluginState), {}, {
+              documentSizeBreachesThreshold: true
+            });
+          }
           return _objectSpread(_objectSpread({}, currentPluginState), {}, {
-            documentSizeBreachesThreshold: true
+            documentSizeBreachesThreshold: false
           });
         }
-        return _objectSpread(_objectSpread({}, currentPluginState), {}, {
-          documentSizeBreachesThreshold: false
-        });
       }
     }
   });

package/dist/es2019/limitedModePlugin.js

@@ -48,6 +48,10 @@ export const limitedModePlugin = ({
         // eslint-disable-next-line react-hooks/exhaustive-deps
       }, [options.contentId]);
       const checkAndShowFlag = useCallback(isLimitedModeEnabled => {
+        if (!(expVal('cc_editor_limited_mode', 'flagEnabled', true) === true)) {
+          // Disable the flag behavior entirely if the flag is off
+          return;
+        }
         const learnMoreLink = expVal('cc_editor_limited_mode', 'learnMoreLink', '');
         if (isLimitedModeEnabled && hasEditorBeenFocusedRef.current && !hasShownFlagRef.current) {
           var _options$showFlag;

package/dist/es2019/pm-plugins/main.js

@@ -5,36 +5,80 @@ export const limitedModePluginKey = new PluginKey('limitedModePlugin');
 export const createPlugin = () => {
   return new SafePlugin({
     key: limitedModePluginKey,
+    // @ts-ignore - Workaround for help-center local consumption
+
     view: _view => {
       return {};
     },
     state: {
+      // @ts-ignore - Workaround for help-center local consumption
+
       init(config, editorState) {
-        if (editorState.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if (expVal('cc_editor_limited_mode_include_lcm', 'isEnabled', true)) {
+          // calculates the size of the doc, where when there are legacy content macros, the content
+          // is stored in the attrs.
+          // This is essentiall doc.nod
+          let customDocSize = editorState.doc.nodeSize;
+          // @ts-ignore - Workaround for help-center local consumption
+
+          editorState.doc.descendants(node => {
+            var _node$attrs;
+            if (((_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.extensionKey) === 'legacy-content') {
+              var _node$attrs$parameter, _node$attrs2, _node$attrs2$paramete, _node$attrs2$paramete2;
+              customDocSize += (_node$attrs$parameter = (_node$attrs2 = node.attrs) === null || _node$attrs2 === void 0 ? void 0 : (_node$attrs2$paramete = _node$attrs2.parameters) === null || _node$attrs2$paramete === void 0 ? void 0 : (_node$attrs2$paramete2 = _node$attrs2$paramete.adf) === null || _node$attrs2$paramete2 === void 0 ? void 0 : _node$attrs2$paramete2.length) !== null && _node$attrs$parameter !== void 0 ? _node$attrs$parameter : 0;
+            }
+          });
           return {
-            documentSizeBreachesThreshold: true
+            documentSizeBreachesThreshold: customDocSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)
+          };
+        } else {
+          if (editorState.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+            return {
+              documentSizeBreachesThreshold: true
+            };
+          }
+          return {
+            documentSizeBreachesThreshold: false
           };
         }
-        return {
-          documentSizeBreachesThreshold: false
-        };
       },
+      // @ts-ignore - Workaround for help-center local consumption
+
       apply: (tr, currentPluginState) => {
         // Don't check the document size if we're already in limited mode.
         // We ALWAYS want to re-check the document size if we're replacing the document (e.g. live-to-live page navigation).
         if (currentPluginState.documentSizeBreachesThreshold && !tr.getMeta('replaceDocument')) {
           return currentPluginState;
         }
-        if (tr.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if (expVal('cc_editor_limited_mode_include_lcm', 'isEnabled', true)) {
+          // calculates the size of the doc, where when there are legacy content macros, the content
+          // is stored in the attrs.
+          // This is essentiall doc.nod
+          let customDocSize = tr.doc.nodeSize;
+          // @ts-ignore - Workaround for help-center local consumption
+
+          tr.doc.descendants(node => {
+            var _node$attrs3;
+            if (((_node$attrs3 = node.attrs) === null || _node$attrs3 === void 0 ? void 0 : _node$attrs3.extensionKey) === 'legacy-content') {
+              var _node$attrs$parameter2, _node$attrs4, _node$attrs4$paramete, _node$attrs4$paramete2;
+              customDocSize += (_node$attrs$parameter2 = (_node$attrs4 = node.attrs) === null || _node$attrs4 === void 0 ? void 0 : (_node$attrs4$paramete = _node$attrs4.parameters) === null || _node$attrs4$paramete === void 0 ? void 0 : (_node$attrs4$paramete2 = _node$attrs4$paramete.adf) === null || _node$attrs4$paramete2 === void 0 ? void 0 : _node$attrs4$paramete2.length) !== null && _node$attrs$parameter2 !== void 0 ? _node$attrs$parameter2 : 0;
+            }
+          });
+          return {
+            documentSizeBreachesThreshold: customDocSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)
+          };
+        } else {
+          if (tr.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+            return {
+              ...currentPluginState,
+              documentSizeBreachesThreshold: true
+            };
+          }
           return {
             ...currentPluginState,
-            documentSizeBreachesThreshold: true
+            documentSizeBreachesThreshold: false
           };
         }
-        return {
-          ...currentPluginState,
-          documentSizeBreachesThreshold: false
-        };
       }
     }
   });

package/dist/esm/limitedModePlugin.js

@@ -46,6 +46,10 @@ export var limitedModePlugin = function limitedModePlugin(_ref) {
         // eslint-disable-next-line react-hooks/exhaustive-deps
       }, [options.contentId]);
       var checkAndShowFlag = useCallback(function (isLimitedModeEnabled) {
+        if (!(expVal('cc_editor_limited_mode', 'flagEnabled', true) === true)) {
+          // Disable the flag behavior entirely if the flag is off
+          return;
+        }
         var _learnMoreLink = expVal('cc_editor_limited_mode', 'learnMoreLink', '');
         if (isLimitedModeEnabled && hasEditorBeenFocusedRef.current && !hasShownFlagRef.current) {
           var _options$showFlag;

package/dist/esm/pm-plugins/main.js

@@ -8,34 +8,77 @@ export var limitedModePluginKey = new PluginKey('limitedModePlugin');
 export var createPlugin = function createPlugin() {
   return new SafePlugin({
     key: limitedModePluginKey,
+    // @ts-ignore - Workaround for help-center local consumption
+
     view: function view(_view) {
       return {};
     },
     state: {
+      // @ts-ignore - Workaround for help-center local consumption
       init: function init(config, editorState) {
-        if (editorState.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if (expVal('cc_editor_limited_mode_include_lcm', 'isEnabled', true)) {
+          // calculates the size of the doc, where when there are legacy content macros, the content
+          // is stored in the attrs.
+          // This is essentiall doc.nod
+          var customDocSize = editorState.doc.nodeSize;
+          // @ts-ignore - Workaround for help-center local consumption
+
+          editorState.doc.descendants(function (node) {
+            var _node$attrs;
+            if (((_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.extensionKey) === 'legacy-content') {
+              var _node$attrs$parameter, _node$attrs2;
+              customDocSize += (_node$attrs$parameter = (_node$attrs2 = node.attrs) === null || _node$attrs2 === void 0 || (_node$attrs2 = _node$attrs2.parameters) === null || _node$attrs2 === void 0 || (_node$attrs2 = _node$attrs2.adf) === null || _node$attrs2 === void 0 ? void 0 : _node$attrs2.length) !== null && _node$attrs$parameter !== void 0 ? _node$attrs$parameter : 0;
+            }
+          });
+          return {
+            documentSizeBreachesThreshold: customDocSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)
+          };
+        } else {
+          if (editorState.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+            return {
+              documentSizeBreachesThreshold: true
+            };
+          }
           return {
-            documentSizeBreachesThreshold: true
+            documentSizeBreachesThreshold: false
           };
         }
-        return {
-          documentSizeBreachesThreshold: false
-        };
       },
+      // @ts-ignore - Workaround for help-center local consumption
+
       apply: function apply(tr, currentPluginState) {
         // Don't check the document size if we're already in limited mode.
         // We ALWAYS want to re-check the document size if we're replacing the document (e.g. live-to-live page navigation).
         if (currentPluginState.documentSizeBreachesThreshold && !tr.getMeta('replaceDocument')) {
           return currentPluginState;
         }
-        if (tr.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if (expVal('cc_editor_limited_mode_include_lcm', 'isEnabled', true)) {
+          // calculates the size of the doc, where when there are legacy content macros, the content
+          // is stored in the attrs.
+          // This is essentiall doc.nod
+          var customDocSize = tr.doc.nodeSize;
+          // @ts-ignore - Workaround for help-center local consumption
+
+          tr.doc.descendants(function (node) {
+            var _node$attrs3;
+            if (((_node$attrs3 = node.attrs) === null || _node$attrs3 === void 0 ? void 0 : _node$attrs3.extensionKey) === 'legacy-content') {
+              var _node$attrs$parameter2, _node$attrs4;
+              customDocSize += (_node$attrs$parameter2 = (_node$attrs4 = node.attrs) === null || _node$attrs4 === void 0 || (_node$attrs4 = _node$attrs4.parameters) === null || _node$attrs4 === void 0 || (_node$attrs4 = _node$attrs4.adf) === null || _node$attrs4 === void 0 ? void 0 : _node$attrs4.length) !== null && _node$attrs$parameter2 !== void 0 ? _node$attrs$parameter2 : 0;
+            }
+          });
+          return {
+            documentSizeBreachesThreshold: customDocSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)
+          };
+        } else {
+          if (tr.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+            return _objectSpread(_objectSpread({}, currentPluginState), {}, {
+              documentSizeBreachesThreshold: true
+            });
+          }
           return _objectSpread(_objectSpread({}, currentPluginState), {}, {
-            documentSizeBreachesThreshold: true
+            documentSizeBreachesThreshold: false
           });
         }
-        return _objectSpread(_objectSpread({}, currentPluginState), {}, {
-          documentSizeBreachesThreshold: false
-        });
       }
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-limited-mode",
-	"version": "3.0.4",
+	"version": "3.1.1",
 	"description": "LimitedMode plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,14 +29,14 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/primitives": "^16.0.0",
-		"@atlaskit/tmp-editor-statsig": "^13.13.0",
+		"@atlaskit/primitives": "^16.3.0",
+		"@atlaskit/tmp-editor-statsig": "^13.42.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.14.0",
+		"@atlaskit/editor-common": "^110.34.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {

package/afm-dev-agents/tsconfig.json

@@ -1,30 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.dev-agents.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../dev-agents/tsDist/@atlaskit__editor-plugin-limited-mode/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/primitives/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../tmp-editor-statsig/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-dev-agents/tsconfig.json"
-		}
-	]
-}

package/afm-passionfruit/tsconfig.json

@@ -1,30 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.passionfruit.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../passionfruit/tsDist/@atlaskit__editor-plugin-limited-mode/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/primitives/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../tmp-editor-statsig/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-passionfruit/tsconfig.json"
-		}
-	]
-}

package/afm-post-office/tsconfig.json

@@ -1,30 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.post-office.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../post-office/tsDist/@atlaskit__editor-plugin-limited-mode/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/primitives/afm-post-office/tsconfig.json"
-		},
-		{
-			"path": "../../tmp-editor-statsig/afm-post-office/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-post-office/tsconfig.json"
-		}
-	]
-}

package/afm-rovo-extension/tsconfig.json

@@ -1,30 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.rovo-extension.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../rovo-extension/tsDist/@atlaskit__editor-plugin-limited-mode/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/primitives/afm-rovo-extension/tsconfig.json"
-		},
-		{
-			"path": "../../tmp-editor-statsig/afm-rovo-extension/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-rovo-extension/tsconfig.json"
-		}
-	]
-}

package/afm-townsquare/tsconfig.json

@@ -1,30 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.townsquare.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../townsquare/tsDist/@atlaskit__editor-plugin-limited-mode/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../../design-system/primitives/afm-townsquare/tsconfig.json"
-		},
-		{
-			"path": "../../tmp-editor-statsig/afm-townsquare/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-townsquare/tsconfig.json"
-		}
-	]
-}