@atlaskit/editor-common 110.10.0 → 110.10.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-common
 
+## 110.10.1
+
+### Patch Changes
+
+- [`a4db0a2351f7d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a4db0a2351f7d) -
+  [ux] ED-29502 Add plain text quick insert option to codeBlockPlugin
+- [`c74a1bd9f8e48`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c74a1bd9f8e48) -
+  EDITOR-1818: extend undo analytics to describe attribute changes. This is to help us investigate
+  undos that have no visible effects
+- Updated dependencies
+
 ## 110.10.0
 
 ### Minor Changes

package/dist/cjs/editor-analytics/withAnalytics.js

@@ -4,6 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.withAnalytics = withAnalytics;
+/**
+ * Meta information that can be passed to the analytics payload callback
+ *
+ * @param currentDoc - Current document node after the transaction
+ */
+
 /**
  * Callback accepts EditorState
  *
@@ -13,6 +19,7 @@ exports.withAnalytics = withAnalytics;
  * Also in cases where Analytics fails to load, the editor doesn't crash.
  *
  * @param state - EditorState, passed to the callback
+ * @param meta - Meta, passed to the callback
  */
 
 /**
@@ -39,7 +46,9 @@ function withAnalytics(analyticsApi, payload, channel) {
       return command(state, function (tr) {
         if (dispatch) {
           if (payload instanceof Function) {
-            var dynamicPayload = payload(state);
+            var dynamicPayload = payload(state, {
+              currentDoc: tr.doc
+            });
             if (dynamicPayload) {
               analyticsApi === null || analyticsApi === void 0 || analyticsApi.attachAnalyticsEvent(dynamicPayload, channel)(tr);
               dispatch(tr);

package/dist/cjs/messages/block-type.js

@@ -91,6 +91,16 @@ var messages = exports.messages = (0, _reactIntlNext.defineMessages)({
     defaultMessage: 'Display code with syntax highlighting',
     description: 'Insert a snippet/segment of code (code block)'
   },
+  plainTextCodeblock: {
+    id: 'fabric.editor.plainTextCodeblock',
+    defaultMessage: 'Plain text',
+    description: 'Insert a snippet/segment of code block as plain text'
+  },
+  plainTextCodeblockDescription: {
+    id: 'fabric.editor.plainTextCodeblock.description',
+    defaultMessage: 'Insert code block for plain text',
+    description: 'Insert a snippet/segment of code block as plain text'
+  },
   infoPanel: {
     id: 'fabric.editor.infoPanel',
     defaultMessage: 'Info panel',

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,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.9.3";
+var packageVersion = "110.10.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

package/dist/es2019/editor-analytics/withAnalytics.js

@@ -1,3 +1,9 @@
+/**
+ * Meta information that can be passed to the analytics payload callback
+ *
+ * @param currentDoc - Current document node after the transaction
+ */
+
 /**
  * Callback accepts EditorState
  *
@@ -7,6 +13,7 @@
  * Also in cases where Analytics fails to load, the editor doesn't crash.
  *
  * @param state - EditorState, passed to the callback
+ * @param meta - Meta, passed to the callback
  */
 
 /**
@@ -31,7 +38,9 @@ export function withAnalytics(analyticsApi, payload, channel) {
   return command => (state, dispatch, view) => command(state, tr => {
     if (dispatch) {
       if (payload instanceof Function) {
-        const dynamicPayload = payload(state);
+        const dynamicPayload = payload(state, {
+          currentDoc: tr.doc
+        });
         if (dynamicPayload) {
           analyticsApi === null || analyticsApi === void 0 ? void 0 : analyticsApi.attachAnalyticsEvent(dynamicPayload, channel)(tr);
           dispatch(tr);

package/dist/es2019/messages/block-type.js

@@ -85,6 +85,16 @@ export const messages = defineMessages({
     defaultMessage: 'Display code with syntax highlighting',
     description: 'Insert a snippet/segment of code (code block)'
   },
+  plainTextCodeblock: {
+    id: 'fabric.editor.plainTextCodeblock',
+    defaultMessage: 'Plain text',
+    description: 'Insert a snippet/segment of code block as plain text'
+  },
+  plainTextCodeblockDescription: {
+    id: 'fabric.editor.plainTextCodeblock.description',
+    defaultMessage: 'Insert code block for plain text',
+    description: 'Insert a snippet/segment of code block as plain text'
+  },
   infoPanel: {
     id: 'fabric.editor.infoPanel',
     defaultMessage: 'Info panel',

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 = "110.9.3";
+const packageVersion = "110.10.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

package/dist/esm/editor-analytics/withAnalytics.js

@@ -1,3 +1,9 @@
+/**
+ * Meta information that can be passed to the analytics payload callback
+ *
+ * @param currentDoc - Current document node after the transaction
+ */
+
 /**
  * Callback accepts EditorState
  *
@@ -7,6 +13,7 @@
  * Also in cases where Analytics fails to load, the editor doesn't crash.
  *
  * @param state - EditorState, passed to the callback
+ * @param meta - Meta, passed to the callback
  */
 
 /**
@@ -33,7 +40,9 @@ export function withAnalytics(analyticsApi, payload, channel) {
       return command(state, function (tr) {
         if (dispatch) {
           if (payload instanceof Function) {
-            var dynamicPayload = payload(state);
+            var dynamicPayload = payload(state, {
+              currentDoc: tr.doc
+            });
             if (dynamicPayload) {
               analyticsApi === null || analyticsApi === void 0 || analyticsApi.attachAnalyticsEvent(dynamicPayload, channel)(tr);
               dispatch(tr);

package/dist/esm/messages/block-type.js

@@ -85,6 +85,16 @@ export var messages = defineMessages({
     defaultMessage: 'Display code with syntax highlighting',
     description: 'Insert a snippet/segment of code (code block)'
   },
+  plainTextCodeblock: {
+    id: 'fabric.editor.plainTextCodeblock',
+    defaultMessage: 'Plain text',
+    description: 'Insert a snippet/segment of code block as plain text'
+  },
+  plainTextCodeblockDescription: {
+    id: 'fabric.editor.plainTextCodeblock.description',
+    defaultMessage: 'Insert code block for plain text',
+    description: 'Insert a snippet/segment of code block as plain text'
+  },
   infoPanel: {
     id: 'fabric.editor.infoPanel',
     defaultMessage: 'Info panel',

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 = "110.9.3";
+var packageVersion = "110.10.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

package/dist/types/analytics/types/events.d.ts

@@ -81,6 +81,11 @@ type MBEEventPayload = TrackAEP<ACTION.ADD_CHILD | ACTION.CHANGE_ACTIVE | ACTION
     localId: string;
 }, undefined>;
 type UndoRedoAEP = TrackAEP<ACTION.UNDO_PERFORMED | ACTION.REDO_PERFORMED, ACTION_SUBJECT.EDITOR, undefined, {
+    affectedNodes?: {
+        attributes: string[];
+        type: string;
+    }[];
+    hasChanged?: boolean;
     inputMethod: INPUT_METHOD.KEYBOARD | INPUT_METHOD.TOOLBAR | INPUT_METHOD.EXTERNAL;
 }, undefined>;
 export type AnalyticsEventPayloadWithChannel = {

package/dist/types/editor-analytics/withAnalytics.d.ts

@@ -1,6 +1,15 @@
+import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '../analytics';
 import type { HigherOrderCommand } from '../types';
+/**
+ * Meta information that can be passed to the analytics payload callback
+ *
+ * @param currentDoc - Current document node after the transaction
+ */
+interface Meta {
+    currentDoc: Node;
+}
 /**
  * Callback accepts EditorState
  *
@@ -10,8 +19,9 @@ import type { HigherOrderCommand } from '../types';
  * Also in cases where Analytics fails to load, the editor doesn't crash.
  *
  * @param state - EditorState, passed to the callback
+ * @param meta - Meta, passed to the callback
  */
-type AnalyticsEventPayloadCallback = (state: EditorState) => AnalyticsEventPayload | undefined;
+type AnalyticsEventPayloadCallback = (state: EditorState, meta: Meta) => AnalyticsEventPayload | undefined;
 /**
  * Analytics API
  * @example

package/dist/types/messages/block-type.d.ts

@@ -84,6 +84,16 @@ export declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    plainTextCodeblock: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    plainTextCodeblockDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
     infoPanel: {
         id: string;
         defaultMessage: string;

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

@@ -5,7 +5,7 @@ import type { TypeAheadItem } from '../types/type-ahead';
 export type QuickInsertActionInsert = (node?: Node | Record<string, any> | string, opts?: {
     selectInlineNode?: boolean;
 }) => Transaction;
-export type QuickInsertItemId = 'hyperlink' | 'table' | 'helpdialog' | 'date' | 'media' | 'media-insert' | 'blockquote' | 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'codeblock' | 'unorderedList' | 'feedbackdialog' | 'orderedList' | 'rule' | 'status' | 'mention' | 'emoji' | 'action' | 'decision' | 'infopanel' | 'notepanel' | 'successpanel' | 'warningpanel' | 'errorpanel' | 'custompanel' | 'layout' | 'expand' | 'placeholderText' | 'datasource' | 'loom' | 'onecolumnlayout' | 'twocolumnslayout' | 'threecolumnslayout' | 'fourcolumnslayout' | 'fivecolumnslayout' | 'syncBlock';
+export type QuickInsertItemId = 'hyperlink' | 'table' | 'helpdialog' | 'date' | 'media' | 'media-insert' | 'blockquote' | 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'codeblock' | 'unorderedList' | 'feedbackdialog' | 'orderedList' | 'rule' | 'status' | 'mention' | 'emoji' | 'action' | 'decision' | 'infopanel' | 'notepanel' | 'successpanel' | 'warningpanel' | 'errorpanel' | 'custompanel' | 'layout' | 'expand' | 'placeholderText' | 'datasource' | 'loom' | 'onecolumnlayout' | 'twocolumnslayout' | 'threecolumnslayout' | 'fourcolumnslayout' | 'fivecolumnslayout' | 'syncBlock' | 'plainText';
 export type QuickInsertItem = TypeAheadItem & {
     /**
      * What to do on insert

package/dist/types-ts4.5/analytics/types/events.d.ts

@@ -81,6 +81,11 @@ type MBEEventPayload = TrackAEP<ACTION.ADD_CHILD | ACTION.CHANGE_ACTIVE | ACTION
     localId: string;
 }, undefined>;
 type UndoRedoAEP = TrackAEP<ACTION.UNDO_PERFORMED | ACTION.REDO_PERFORMED, ACTION_SUBJECT.EDITOR, undefined, {
+    affectedNodes?: {
+        attributes: string[];
+        type: string;
+    }[];
+    hasChanged?: boolean;
     inputMethod: INPUT_METHOD.KEYBOARD | INPUT_METHOD.TOOLBAR | INPUT_METHOD.EXTERNAL;
 }, undefined>;
 export type AnalyticsEventPayloadWithChannel = {

package/dist/types-ts4.5/editor-analytics/withAnalytics.d.ts

@@ -1,6 +1,15 @@
+import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '../analytics';
 import type { HigherOrderCommand } from '../types';
+/**
+ * Meta information that can be passed to the analytics payload callback
+ *
+ * @param currentDoc - Current document node after the transaction
+ */
+interface Meta {
+    currentDoc: Node;
+}
 /**
  * Callback accepts EditorState
  *
@@ -10,8 +19,9 @@ import type { HigherOrderCommand } from '../types';
  * Also in cases where Analytics fails to load, the editor doesn't crash.
  *
  * @param state - EditorState, passed to the callback
+ * @param meta - Meta, passed to the callback
  */
-type AnalyticsEventPayloadCallback = (state: EditorState) => AnalyticsEventPayload | undefined;
+type AnalyticsEventPayloadCallback = (state: EditorState, meta: Meta) => AnalyticsEventPayload | undefined;
 /**
  * Analytics API
  * @example

package/dist/types-ts4.5/messages/block-type.d.ts

@@ -84,6 +84,16 @@ export declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    plainTextCodeblock: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    plainTextCodeblockDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
     infoPanel: {
         id: string;
         defaultMessage: string;

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

@@ -5,7 +5,7 @@ import type { TypeAheadItem } from '../types/type-ahead';
 export type QuickInsertActionInsert = (node?: Node | Record<string, any> | string, opts?: {
     selectInlineNode?: boolean;
 }) => Transaction;
-export type QuickInsertItemId = 'hyperlink' | 'table' | 'helpdialog' | 'date' | 'media' | 'media-insert' | 'blockquote' | 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'codeblock' | 'unorderedList' | 'feedbackdialog' | 'orderedList' | 'rule' | 'status' | 'mention' | 'emoji' | 'action' | 'decision' | 'infopanel' | 'notepanel' | 'successpanel' | 'warningpanel' | 'errorpanel' | 'custompanel' | 'layout' | 'expand' | 'placeholderText' | 'datasource' | 'loom' | 'onecolumnlayout' | 'twocolumnslayout' | 'threecolumnslayout' | 'fourcolumnslayout' | 'fivecolumnslayout' | 'syncBlock';
+export type QuickInsertItemId = 'hyperlink' | 'table' | 'helpdialog' | 'date' | 'media' | 'media-insert' | 'blockquote' | 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'codeblock' | 'unorderedList' | 'feedbackdialog' | 'orderedList' | 'rule' | 'status' | 'mention' | 'emoji' | 'action' | 'decision' | 'infopanel' | 'notepanel' | 'successpanel' | 'warningpanel' | 'errorpanel' | 'custompanel' | 'layout' | 'expand' | 'placeholderText' | 'datasource' | 'loom' | 'onecolumnlayout' | 'twocolumnslayout' | 'threecolumnslayout' | 'fourcolumnslayout' | 'fivecolumnslayout' | 'syncBlock' | 'plainText';
 export type QuickInsertItem = TypeAheadItem & {
     /**
      * What to do on insert

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "110.10.0",
+	"version": "110.10.1",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -82,7 +82,7 @@
 		"@atlaskit/task-decision": "^19.2.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/theme": "^21.0.0",
-		"@atlaskit/tmp-editor-statsig": "^13.6.0",
+		"@atlaskit/tmp-editor-statsig": "^13.7.0",
 		"@atlaskit/tokens": "^6.4.0",
 		"@atlaskit/tooltip": "^20.5.0",
 		"@atlaskit/width-detector": "^5.0.0",