@atlaskit/editor-common 118.6.0 → 118.8.0

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @atlaskit/editor-common
 
+## 118.8.0
+
+### Minor Changes
+
+- [`c0cf420333ef1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c0cf420333ef1) -
+  Add public registration APIs for provider-backed Quick Insert components.
+
+  Providers can expose registered items directly:
+
+  ```tsx
+  const getComponents = async () => [
+  	{
+  		key: 'insert-table',
+  		component: TableItem,
+  		parents: [{ type: 'menu-section', key: 'quick-insert', rank: 1 }],
+  	},
+  ];
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
+## 118.7.0
+
+### Minor Changes
+
+- [`882186c3b96b6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/882186c3b96b6) -
+  Add an optional `hideCopyButton` capability to extension manifest nodes (`ExtensionModuleNode`).
+  When set, the extension's selection floating toolbar hides the copy button. Used by the redaction
+  extension so redacted content is delete-only (no copy, no configure).
+
+  The new toolbar behaviour is gated behind `platform_editor_extension_hide_copy_button`. When the
+  gate is off, the toolbar renders exactly as before. When the copy button is hidden, the trailing
+  toolbar separator is also hidden so delete-only toolbars do not render an orphaned divider.
+
+  ```ts
+  const manifest: ExtensionManifest = {
+  	// ...
+  	modules: {
+  		nodes: {
+  			default: {
+  				type: 'inlineExtension',
+  				render: () => import('./MyExtension'),
+  				// Hide the copy button on this node's selection toolbar
+  				hideCopyButton: true,
+  			},
+  		},
+  	},
+  };
+  ```
+
 ## 118.6.0
 
 ### Minor Changes

package/afm-cc/tsconfig.json

@@ -82,6 +82,9 @@
 		{
 			"path": "../../editor-toolbar-model/afm-cc/tsconfig.json"
 		},
+		{
+			"path": "../../editor-ui-control-model/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../../elements/emoji/afm-cc/tsconfig.json"
 		},

package/afm-products/tsconfig.json

@@ -82,6 +82,9 @@
 		{
 			"path": "../../editor-toolbar-model/afm-products/tsconfig.json"
 		},
+		{
+			"path": "../../editor-ui-control-model/afm-products/tsconfig.json"
+		},
 		{
 			"path": "../../../elements/emoji/afm-products/tsconfig.json"
 		},

package/connectivity/isOfflineMode/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/connectivity/isOfflineMode",
+  "main": "../../dist/cjs/connectivity/isOfflineMode.js",
+  "module": "../../dist/esm/connectivity/isOfflineMode.js",
+  "module:es2019": "../../dist/es2019/connectivity/isOfflineMode.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../../dist/types/connectivity/isOfflineMode.d.ts"
+}

package/connectivity/mode/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/connectivity/mode",
+  "main": "../../dist/cjs/connectivity/mode.js",
+  "module": "../../dist/esm/connectivity/mode.js",
+  "module:es2019": "../../dist/es2019/connectivity/mode.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../../dist/types/connectivity/mode.d.ts"
+}

package/dist/cjs/connectivity/isOfflineMode.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isOfflineMode = void 0;
+/**
+ * Check if the connectivity mode represents ANY offline state
+ */
+var isOfflineMode = exports.isOfflineMode = function isOfflineMode(mode) {
+  return mode === 'offline' || mode === 'collab-offline' || mode === 'internet-offline';
+};

package/dist/cjs/connectivity/mode.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cjs/monitoring/error.js

@@ -28,7 +28,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "118.5.0";
+var packageVersion = "118.7.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/provider-helpers/combine-providers.js

@@ -148,8 +148,42 @@ var _default = exports.default = function _default(providers) {
       return _ref5.apply(this, arguments);
     };
   }();
+
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  var invokeOptionalList = /*#__PURE__*/function () {
+    var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(methodName, args) {
+      var providersWithMethod, results, fulfilledResults;
+      return _regenerator.default.wrap(function (_context5) {
+        while (1) switch (_context5.prev = _context5.next) {
+          case 0:
+            _context5.next = 1;
+            return getFulfilledProviders();
+          case 1:
+            providersWithMethod = _context5.sent.filter(function (provider) {
+              return typeof provider[methodName] === 'function';
+            });
+            _context5.next = 2;
+            return (0, _promiseHelpers.waitForAllPromises)(providersWithMethod.map(createCallback(methodName, args)));
+          case 2:
+            results = _context5.sent;
+            fulfilledResults = (0, _promiseHelpers.getOnlyFulfilled)(results);
+            return _context5.abrupt("return", flatten(fulfilledResults).filter(function (result) {
+              return result;
+            }));
+          case 3:
+          case "end":
+            return _context5.stop();
+        }
+      }, _callee5);
+    }));
+    return function invokeOptionalList(_x6, _x7) {
+      return _ref6.apply(this, arguments);
+    };
+  }();
   return {
     invokeSingle: invokeSingle,
-    invokeList: invokeList
+    invokeList: invokeList,
+    invokeOptionalList: invokeOptionalList
   };
 };

package/dist/cjs/quick-insert/getQuickInsertProviderMenuItemKey.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getQuickInsertProviderMenuItemKey = void 0;
+var getQuickInsertProviderMenuItemKey = exports.getQuickInsertProviderMenuItemKey = function getQuickInsertProviderMenuItemKey(key) {
+  return "quick-insert-provider-".concat(key);
+};

package/dist/cjs/quick-insert/rank.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.TEXT_FORMATTING_SECTION_RANK = exports.STRUCTURE_SECTION_RANK = exports.ROVO_SECTION_RANK = exports.QUICK_INSERT_MENU_RANK = exports.MEDIA_SECTION_RANK = exports.DATA_AND_CHARTS_SECTION_RANK = exports.CATEGORY_VIEW_MORE_RANK = void 0;
+exports.TEXT_FORMATTING_SECTION_RANK = exports.STRUCTURE_SECTION_RANK = exports.ROVO_SECTION_RANK = exports.QUICK_INSERT_MENU_RANK = exports.MEDIA_SECTION_RANK = exports.EXTENSION_ITEM_RANK = exports.DATA_AND_CHARTS_SECTION_RANK = exports.CATEGORY_VIEW_MORE_RANK = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _keys = require("./keys");
 /* eslint-disable @atlaskit/volt-strict-mode/no-multiple-exports */
@@ -15,4 +15,5 @@ var MEDIA_SECTION_RANK = exports.MEDIA_SECTION_RANK = (0, _defineProperty2.defau
 var TEXT_FORMATTING_SECTION_RANK = exports.TEXT_FORMATTING_SECTION_RANK = (0, _defineProperty2.default)((0, _defineProperty2.default)({}, _keys.UNORDERED_LIST_MENU_ITEM.key, 1100), _keys.ORDERED_LIST_MENU_ITEM.key, 1200);
 var ROVO_SECTION_RANK = exports.ROVO_SECTION_RANK = (0, _defineProperty2.default)({}, _keys.ASK_ROVO_MENU_ITEM.key, 100);
 var DATA_AND_CHARTS_SECTION_RANK = exports.DATA_AND_CHARTS_SECTION_RANK = (0, _defineProperty2.default)((0, _defineProperty2.default)({}, _keys.JIRA_WORK_ITEMS_MENU_ITEM.key, 300), _keys.ASSETS_MENU_ITEM.key, 500);
+var EXTENSION_ITEM_RANK = exports.EXTENSION_ITEM_RANK = 1500;
 var CATEGORY_VIEW_MORE_RANK = exports.CATEGORY_VIEW_MORE_RANK = Number.MAX_SAFE_INTEGER;

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

package/dist/es2019/connectivity/isOfflineMode.js

@@ -0,0 +1,6 @@
+/**
+ * Check if the connectivity mode represents ANY offline state
+ */
+export const isOfflineMode = mode => {
+  return mode === 'offline' || mode === 'collab-offline' || mode === 'internet-offline';
+};

package/dist/es2019/monitoring/error.js

@@ -14,7 +14,7 @@ const NETWORK_FAILURE_REGEX = /^network failure/i;
 const RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "118.5.0";
+const packageVersion = "118.7.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/provider-helpers/combine-providers.js

@@ -55,8 +55,18 @@ export default (providers => {
     const fulfilledResults = getOnlyFulfilled(results);
     return flatten(fulfilledResults).filter(result => result);
   };
+
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const invokeOptionalList = async (methodName, args) => {
+    const providersWithMethod = (await getFulfilledProviders()).filter(provider => typeof provider[methodName] === 'function');
+    const results = await waitForAllPromises(providersWithMethod.map(createCallback(methodName, args)));
+    const fulfilledResults = getOnlyFulfilled(results);
+    return flatten(fulfilledResults).filter(result => result);
+  };
   return {
     invokeSingle,
-    invokeList
+    invokeList,
+    invokeOptionalList
   };
 });

package/dist/es2019/quick-insert/getQuickInsertProviderMenuItemKey.js

@@ -0,0 +1 @@
+export const getQuickInsertProviderMenuItemKey = key => `quick-insert-provider-${key}`;

package/dist/es2019/quick-insert/rank.js

@@ -39,4 +39,5 @@ export const DATA_AND_CHARTS_SECTION_RANK = {
   [JIRA_WORK_ITEMS_MENU_ITEM.key]: 300,
   [ASSETS_MENU_ITEM.key]: 500
 };
+export const EXTENSION_ITEM_RANK = 1500;
 export const CATEGORY_VIEW_MORE_RANK = Number.MAX_SAFE_INTEGER;

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 = "118.5.0";
+const packageVersion = "118.7.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/connectivity/isOfflineMode.js

@@ -0,0 +1,6 @@
+/**
+ * Check if the connectivity mode represents ANY offline state
+ */
+export var isOfflineMode = function isOfflineMode(mode) {
+  return mode === 'offline' || mode === 'collab-offline' || mode === 'internet-offline';
+};

package/dist/esm/monitoring/error.js

@@ -20,7 +20,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 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 = "118.5.0";
+var packageVersion = "118.7.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/provider-helpers/combine-providers.js

@@ -141,8 +141,42 @@ export default (function (providers) {
       return _ref5.apply(this, arguments);
     };
   }();
+
+  // Ignored via go/ees005
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  var invokeOptionalList = /*#__PURE__*/function () {
+    var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(methodName, args) {
+      var providersWithMethod, results, fulfilledResults;
+      return _regeneratorRuntime.wrap(function (_context5) {
+        while (1) switch (_context5.prev = _context5.next) {
+          case 0:
+            _context5.next = 1;
+            return getFulfilledProviders();
+          case 1:
+            providersWithMethod = _context5.sent.filter(function (provider) {
+              return typeof provider[methodName] === 'function';
+            });
+            _context5.next = 2;
+            return waitForAllPromises(providersWithMethod.map(createCallback(methodName, args)));
+          case 2:
+            results = _context5.sent;
+            fulfilledResults = getOnlyFulfilled(results);
+            return _context5.abrupt("return", flatten(fulfilledResults).filter(function (result) {
+              return result;
+            }));
+          case 3:
+          case "end":
+            return _context5.stop();
+        }
+      }, _callee5);
+    }));
+    return function invokeOptionalList(_x6, _x7) {
+      return _ref6.apply(this, arguments);
+    };
+  }();
   return {
     invokeSingle: invokeSingle,
-    invokeList: invokeList
+    invokeList: invokeList,
+    invokeOptionalList: invokeOptionalList
   };
 });

package/dist/esm/quick-insert/getQuickInsertProviderMenuItemKey.js

@@ -0,0 +1,3 @@
+export var getQuickInsertProviderMenuItemKey = function getQuickInsertProviderMenuItemKey(key) {
+  return "quick-insert-provider-".concat(key);
+};

package/dist/esm/quick-insert/rank.js

@@ -7,4 +7,5 @@ export var MEDIA_SECTION_RANK = _defineProperty(_defineProperty(_defineProperty(
 export var TEXT_FORMATTING_SECTION_RANK = _defineProperty(_defineProperty({}, UNORDERED_LIST_MENU_ITEM.key, 1100), ORDERED_LIST_MENU_ITEM.key, 1200);
 export var ROVO_SECTION_RANK = _defineProperty({}, ASK_ROVO_MENU_ITEM.key, 100);
 export var DATA_AND_CHARTS_SECTION_RANK = _defineProperty(_defineProperty({}, JIRA_WORK_ITEMS_MENU_ITEM.key, 300), ASSETS_MENU_ITEM.key, 500);
+export var EXTENSION_ITEM_RANK = 1500;
 export var CATEGORY_VIEW_MORE_RANK = Number.MAX_SAFE_INTEGER;

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 = "118.5.0";
+var packageVersion = "118.7.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/connectivity/isOfflineMode.d.ts

@@ -0,0 +1,5 @@
+import type { Mode } from './mode';
+/**
+ * Check if the connectivity mode represents ANY offline state
+ */
+export declare const isOfflineMode: (mode: Mode | undefined) => boolean;

package/dist/types/connectivity/mode.d.ts

@@ -0,0 +1 @@
+export type Mode = 'offline' | 'online' | 'collab-offline' | 'internet-offline';

package/dist/types/extensions/types/extension-manifest.d.ts

@@ -43,6 +43,11 @@ export type DynamicFieldDefinitions<T> = (parameters: T) => FieldDefinition[];
 export type ExtensionModuleNode<T extends Parameters = Parameters> = {
     blockTransform?: BlockTransformExtension;
     getFieldsDefinition?: (extensionParameters: T) => Promise<FieldDefinition[] | DynamicFieldDefinitions<T>>;
+    /**
+     * When true, the copy button is hidden from this node's selection toolbar.
+     * Use for nodes whose content should not be copied (e.g. redactions).
+     */
+    hideCopyButton?: boolean;
     render: () => ExtensionComponentModule<T>;
     type: 'extension' | 'inlineExtension' | 'bodiedExtension' | 'multiBodiedExtension';
     update?: UpdateExtension<T>;

package/dist/types/provider-factory/quick-insert-provider.d.ts

@@ -1,5 +1,6 @@
 import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
 import type { INPUT_METHOD } from '../analytics/types/enums';
 import type { TypeAheadItem } from '../types/type-ahead';
 export type QuickInsertActionInsert = (node?: Node | Record<string, any> | string, opts?: {
@@ -25,5 +26,7 @@ export type QuickInsertItem = TypeAheadItem & {
     keywords?: Array<string>;
 };
 export type QuickInsertProvider = {
+    /** Registered leaf items for the Quick Insert browse menu. */
+    getComponents?: () => Promise<Array<RegisterMenuItem>>;
     getItems: () => Promise<Array<QuickInsertItem>>;
 };

package/dist/types/provider-helpers/combine-providers.d.ts

@@ -5,5 +5,6 @@ export default _default;
  */
 declare function _default<P>(providers: (P | Promise<P>)[]): {
     invokeList: <T>(methodName: keyof P, args?: any[]) => Promise<T[]>;
+    invokeOptionalList: <T>(methodName: keyof P, args?: any[]) => Promise<T[]>;
     invokeSingle: <T>(methodName: keyof P, args?: any[]) => Promise<T>;
 };

package/dist/types/quick-insert/QuickInsertContext.d.ts

@@ -9,6 +9,7 @@ export type QuickInsertSelectionHandler = (context: {
 }) => Transaction | false | void;
 export type QuickInsertContextValue = {
     editorView: EditorView;
+    isOffline: boolean;
     item?: {
         id: string;
         isSelected: boolean;

package/dist/types/quick-insert/getQuickInsertProviderMenuItemKey.d.ts

@@ -0,0 +1 @@
+export declare const getQuickInsertProviderMenuItemKey: (key: string) => string;

package/dist/types/quick-insert/rank.d.ts

@@ -37,4 +37,5 @@ export declare const DATA_AND_CHARTS_SECTION_RANK: {
     readonly 'quick-insert-assets-menu-item': 500;
     readonly 'quick-insert-jira-work-items-menu-item': 300;
 };
+export declare const EXTENSION_ITEM_RANK = 1500;
 export declare const CATEGORY_VIEW_MORE_RANK: number;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "118.6.0",
+	"version": "118.8.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -49,6 +49,7 @@
 		"@atlaskit/editor-tables": "^3.0.0",
 		"@atlaskit/editor-toolbar": "^2.4.0",
 		"@atlaskit/editor-toolbar-model": "^1.2.0",
+		"@atlaskit/editor-ui-control-model": "^2.5.0",
 		"@atlaskit/emoji": "^71.16.0",
 		"@atlaskit/feature-gate-js-client": "^6.0.0",
 		"@atlaskit/icon": "^37.3.0",

package/quick-insert/get-provider-menu-item-key/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-common/quick-insert/get-provider-menu-item-key",
+  "main": "../../dist/cjs/quick-insert/getQuickInsertProviderMenuItemKey.js",
+  "module": "../../dist/esm/quick-insert/getQuickInsertProviderMenuItemKey.js",
+  "module:es2019": "../../dist/es2019/quick-insert/getQuickInsertProviderMenuItemKey.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../../dist/types/quick-insert/getQuickInsertProviderMenuItemKey.d.ts"
+}