@atlaskit/editor-plugin-track-changes 7.0.29 → 7.0.31

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-track-changes
 
+## 7.0.31
+
+### Patch Changes
+
+- [`7b7c52dff5d7d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7b7c52dff5d7d) -
+  Fix eslint violations for type import syntax
+- Updated dependencies
+
+## 7.0.30
+
+### Patch Changes
+
+- [`9ff7d1c1aa288`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9ff7d1c1aa288) -
+  Update README.md and 0-intro.tsx
+- Updated dependencies
+
 ## 7.0.29
 
 ### Patch Changes

package/README.md

@@ -1,9 +1,30 @@
-# Editor plugin track changes
+# Editor Plugin Track Changes
 
 Track changes plugin for @atlaskit/editor-core
 
+## Overview
+
+The Track Changes plugin enables tracking and display of document changes in the Atlassian Editor. It integrates with the Show Diff plugin to visualize content modifications and provides commands to toggle the display of changes and reset the baseline for comparison.
+
+## Key features
+
+- **Toggle change display** - Show or hide tracked changes in the editor using the `toggleChanges` command
+- **Baseline reset** - Reset the baseline used for tracking changes with the `resetBaseline` command
+- **Toolbar integration** - Optionally display a track changes button in the editor toolbar
+- **Shared state** - Access the state of change display and diff availability through shared plugin state
+- **Show Diff integration** - Works seamlessly with the Show Diff plugin for visual change representation
+
+## Install
+
+- **Install** - `yarn add @atlaskit/editor-plugin-track-changes`
+- **npm** - [@atlaskit/editor-plugin-track-changes](https://www.npmjs.com/package/@atlaskit/editor-plugin-track-changes)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-track-changes)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-track-changes/dist/)
+
 ## Usage
 
+### Import
+
 `import { trackChangesPlugin } from '@atlaskit/editor-plugin-track-changes';`
 
 ### Dependencies
@@ -13,6 +34,7 @@ Track changes plugin for @atlaskit/editor-core
 
 **Optional:**
 - `PrimaryToolbarPlugin` - Required if using `showOnToolbar: true`
+- `ToolbarPlugin` - Alternative toolbar plugin for registering the track changes button
 
 ### Configuration
 
@@ -87,3 +109,11 @@ export default Editor;
 ```
 
 Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-track-changes).
+
+## Support
+
+For support, visit the [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) Slack channel or submit an issue via [go/editor-help](https://go/editor-help).
+
+## License
+
+Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

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

@@ -42,7 +42,7 @@ var getBaselineFromSteps = exports.getBaselineFromSteps = function getBaselineFr
       _iterator.f();
     }
     return doc;
-  } catch (e) {
+  } catch (_unused) {
     // Temporary - we need to understand how this happens - but we want to unblock issues where this crashes the editor
     return undefined;
   }

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

@@ -17,7 +17,7 @@ export const getBaselineFromSteps = (doc, steps) => {
       }
     }
     return doc;
-  } catch (e) {
+  } catch {
     // Temporary - we need to understand how this happens - but we want to unblock issues where this crashes the editor
     return undefined;
   }

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

@@ -35,7 +35,7 @@ export var getBaselineFromSteps = function getBaselineFromSteps(doc, steps) {
       _iterator.f();
     }
     return doc;
-  } catch (e) {
+  } catch (_unused) {
     // Temporary - we need to understand how this happens - but we want to unblock issues where this crashes the editor
     return undefined;
   }

package/dist/types/pm-plugins/invertableStep.d.ts

@@ -1,4 +1,4 @@
-import { type Step } from '@atlaskit/editor-prosemirror/transform';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 export declare class InvertableStep {
     readonly step: Step;
     readonly inverted: Step;

package/dist/types/pm-plugins/main.d.ts

@@ -1,5 +1,5 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { TrackChangesPlugin } from '../trackChangesPluginType';

package/dist/types/trackChangesPluginType.d.ts

@@ -1,6 +1,6 @@
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { HistoryPlugin } from '@atlaskit/editor-plugin-history';
-import { type PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
+import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
 import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
 export interface TrackChangesPluginOptions {

package/dist/types/ui/TrackChangesToolbarButton.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { type TrackChangesPlugin } from '../trackChangesPluginType';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { TrackChangesPlugin } from '../trackChangesPluginType';
 type TrackChangesToolbarButtonProps = {
     api: ExtractInjectionAPI<TrackChangesPlugin> | undefined;
     wrapper?: React.ComponentType<{

package/dist/types-ts4.5/pm-plugins/invertableStep.d.ts

@@ -1,4 +1,4 @@
-import { type Step } from '@atlaskit/editor-prosemirror/transform';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 export declare class InvertableStep {
     readonly step: Step;
     readonly inverted: Step;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -1,5 +1,5 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { TrackChangesPlugin } from '../trackChangesPluginType';

package/dist/types-ts4.5/trackChangesPluginType.d.ts

@@ -1,6 +1,6 @@
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { HistoryPlugin } from '@atlaskit/editor-plugin-history';
-import { type PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
+import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
 import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
 export interface TrackChangesPluginOptions {

package/dist/types-ts4.5/ui/TrackChangesToolbarButton.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { type TrackChangesPlugin } from '../trackChangesPluginType';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { TrackChangesPlugin } from '../trackChangesPluginType';
 type TrackChangesToolbarButtonProps = {
     api: ExtractInjectionAPI<TrackChangesPlugin> | undefined;
     wrapper?: React.ComponentType<{

package/docs/0-intro.tsx

@@ -31,10 +31,26 @@ The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\
 below:
 
 ${code`
+interface TrackChangesPluginOptions {
+  /**
+   * Custom wrapper component for the track changes button.
+   */
+  ButtonWrapper?: React.ComponentType<{ children: React.ReactNode }>;
+  /**
+   * Whether the track changes button should be shown on the toolbar.
+   * Defaults to false.
+   */
+  showOnToolbar?: boolean;
+}
+
 type TrackChangesPlugin = NextEditorPlugin<
   'trackChanges',
   {
     commands: {
+      /**
+       * Resets the baseline used for tracking changes in the editor.
+       */
+      resetBaseline: EditorCommand;
       /**
        * Toggles the displaying of changes in the editor.
        */
@@ -45,18 +61,20 @@ type TrackChangesPlugin = NextEditorPlugin<
        * Primary toolbar plugin for registering the track changes button.
        */
       OptionalPlugin<PrimaryToolbarPlugin>,
+      /**
+       * For ensuring the tracked changes align with the history
+       */
+      OptionalPlugin<HistoryPlugin>,
       /**
        * Show diff plugin for showing the changes in a diff view.
        */
       ShowDiffPlugin,
-    ];
-    pluginConfiguration?: {
       /**
-       * Whether the track changes button should be shown on the toolbar.
-       * Defaults to false.
+       * Toolbar plugin for registering the track changes button. Will be replacing the Primary Toolbar Plugin
        */
-      showOnToolbar?: boolean;
-    };
+      OptionalPlugin<ToolbarPlugin>,
+    ];
+    pluginConfiguration?: TrackChangesPluginOptions;
     sharedState: {
       /**
        * Whether the track changes feature is currently displaying changes.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-track-changes",
-	"version": "7.0.29",
+	"version": "7.0.31",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -31,7 +31,7 @@
 		"@atlaskit/button": "^23.11.0",
 		"@atlaskit/editor-plugin-history": "8.0.1",
 		"@atlaskit/editor-plugin-primary-toolbar": "^9.0.0",
-		"@atlaskit/editor-plugin-show-diff": "6.2.14",
+		"@atlaskit/editor-plugin-show-diff": "6.2.16",
 		"@atlaskit/editor-plugin-toolbar": "^5.1.0",
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/editor-toolbar": "^0.20.0",