@atlaskit/editor-plugin-show-diff 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 0.1.5
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+
+## 0.1.4
+
+### Patch Changes
+
+- [`1fc9ea612c6ef`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1fc9ea612c6ef) -
+  [EDITOR-1358] Fix nit + minor local bug
+
 ## 0.1.3
 
 ### Patch Changes

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

@@ -53,7 +53,7 @@ var NodeViewSerializer = exports.NodeViewSerializer = /*#__PURE__*/function () {
       this.editorView = params.editorView;
     }
     this.nodeViews = (_ref = (_params$nodeViews = params.nodeViews) !== null && _params$nodeViews !== void 0 ? _params$nodeViews : (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.nodeViews) !== null && _ref !== void 0 ? _ref : {};
-    this.nodeViewBlocklist = new Set((_params$blocklist = params.blocklist) !== null && _params$blocklist !== void 0 ? _params$blocklist : ['tableRow', 'table']);
+    this.nodeViewBlocklist = new Set((_params$blocklist = params.blocklist) !== null && _params$blocklist !== void 0 ? _params$blocklist : ['tableRow', 'table', 'paragraph']);
   }
 
   /**
@@ -92,7 +92,6 @@ var NodeViewSerializer = exports.NodeViewSerializer = /*#__PURE__*/function () {
     /**
      * Serializes a fragment to a `DocumentFragment` using the schema's `DOMSerializer`.
      */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
   }, {
     key: "serializeFragment",
     value: function serializeFragment(fragment) {

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

@@ -43,7 +43,7 @@ export class NodeViewSerializer {
       this.editorView = params.editorView;
     }
     this.nodeViews = (_ref = (_params$nodeViews = params.nodeViews) !== null && _params$nodeViews !== void 0 ? _params$nodeViews : (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.nodeViews) !== null && _ref !== void 0 ? _ref : {};
-    this.nodeViewBlocklist = new Set((_params$blocklist = params.blocklist) !== null && _params$blocklist !== void 0 ? _params$blocklist : ['tableRow', 'table']);
+    this.nodeViewBlocklist = new Set((_params$blocklist = params.blocklist) !== null && _params$blocklist !== void 0 ? _params$blocklist : ['tableRow', 'table', 'paragraph']);
   }
 
   /**
@@ -76,7 +76,6 @@ export class NodeViewSerializer {
   /**
    * Serializes a fragment to a `DocumentFragment` using the schema's `DOMSerializer`.
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   serializeFragment(fragment) {
     return this.serializer.serializeFragment(fragment);
   }

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

@@ -46,7 +46,7 @@ export var NodeViewSerializer = /*#__PURE__*/function () {
       this.editorView = params.editorView;
     }
     this.nodeViews = (_ref = (_params$nodeViews = params.nodeViews) !== null && _params$nodeViews !== void 0 ? _params$nodeViews : (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.nodeViews) !== null && _ref !== void 0 ? _ref : {};
-    this.nodeViewBlocklist = new Set((_params$blocklist = params.blocklist) !== null && _params$blocklist !== void 0 ? _params$blocklist : ['tableRow', 'table']);
+    this.nodeViewBlocklist = new Set((_params$blocklist = params.blocklist) !== null && _params$blocklist !== void 0 ? _params$blocklist : ['tableRow', 'table', 'paragraph']);
   }
 
   /**
@@ -85,7 +85,6 @@ export var NodeViewSerializer = /*#__PURE__*/function () {
     /**
      * Serializes a fragment to a `DocumentFragment` using the schema's `DOMSerializer`.
      */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
   }, {
     key: "serializeFragment",
     value: function serializeFragment(fragment) {

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

@@ -1,5 +1,5 @@
 import { type NodeViewConstructor } from '@atlaskit/editor-common/lazy-node-view';
-import type { Schema, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Schema, Node as PMNode, Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 /**
  * Utilities for working with ProseMirror node views and DOM serialization within the
@@ -39,10 +39,10 @@ export declare class NodeViewSerializer {
     private nodeViews;
     private nodeViewBlocklist;
     constructor(params: {
-        schema: Schema;
+        blocklist?: string[];
         editorView?: EditorView;
         nodeViews?: Record<string, NodeViewConstructor>;
-        blocklist?: string[];
+        schema: Schema;
     });
     /**
      * Attempts to create a node view for the given node.
@@ -58,5 +58,5 @@ export declare class NodeViewSerializer {
     /**
      * Serializes a fragment to a `DocumentFragment` using the schema's `DOMSerializer`.
      */
-    serializeFragment(fragment: any): DocumentFragment | HTMLElement;
+    serializeFragment(fragment: Fragment): DocumentFragment | HTMLElement;
 }

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

@@ -17,9 +17,9 @@ export declare const createInlineChangedDecoration: (change: {
 interface DeletedContentDecorationProps {
     change: Change;
     doc: PMNode;
-    tr: Transaction;
-    nodeViews: Record<string, NodeViewConstructor>;
     editorView?: EditorView;
+    nodeViews: Record<string, NodeViewConstructor>;
+    tr: Transaction;
 }
 /**
  * Creates a widget to represent the deleted content in the editor

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

@@ -6,10 +6,10 @@ import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { type DiffParams } from '../showDiffPluginType';
 export declare const showDiffPluginKey: PluginKey<ShowDiffPluginState>;
 type ShowDiffPluginState = {
-    steps: ProseMirrorStep[];
-    originalDoc: PMNode | undefined;
     decorations: DecorationSet;
     isDisplayingChanges: boolean;
+    originalDoc: PMNode | undefined;
+    steps: ProseMirrorStep[];
 };
 export declare const createPlugin: (config: DiffParams | undefined) => SafePlugin<ShowDiffPluginState>;
 export {};

package/dist/types/showDiffPluginType.d.ts

@@ -4,26 +4,26 @@ import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
 export type DiffParams = {
+    originalDoc: JSONDocNode;
     /**
      * Prosemirror steps. This is used to calculate and show the diff in the editor
      */
     steps: StepJson[];
-    originalDoc: JSONDocNode;
 };
 export type PMDiffParams = {
+    originalDoc: Node;
     /**
      * Prosemirror steps. This is used to calculate and show the diff in the editor
      */
     steps: Step[];
-    originalDoc: Node;
 };
 export type ACTION = 'SHOW_DIFF' | 'HIDE_DIFF';
 export type ShowDiffPlugin = NextEditorPlugin<'showDiff', {
-    pluginConfiguration: DiffParams | undefined;
     commands: {
-        showDiff: (config: PMDiffParams) => EditorCommand;
         hideDiff: EditorCommand;
+        showDiff: (config: PMDiffParams) => EditorCommand;
     };
+    pluginConfiguration: DiffParams | undefined;
     sharedState: {
         /**
          * Whether the show diff feature is currently displaying changes.

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

@@ -1,5 +1,5 @@
 import { type NodeViewConstructor } from '@atlaskit/editor-common/lazy-node-view';
-import type { Schema, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Schema, Node as PMNode, Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 /**
  * Utilities for working with ProseMirror node views and DOM serialization within the
@@ -39,10 +39,10 @@ export declare class NodeViewSerializer {
     private nodeViews;
     private nodeViewBlocklist;
     constructor(params: {
-        schema: Schema;
+        blocklist?: string[];
         editorView?: EditorView;
         nodeViews?: Record<string, NodeViewConstructor>;
-        blocklist?: string[];
+        schema: Schema;
     });
     /**
      * Attempts to create a node view for the given node.
@@ -58,5 +58,5 @@ export declare class NodeViewSerializer {
     /**
      * Serializes a fragment to a `DocumentFragment` using the schema's `DOMSerializer`.
      */
-    serializeFragment(fragment: any): DocumentFragment | HTMLElement;
+    serializeFragment(fragment: Fragment): DocumentFragment | HTMLElement;
 }

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

@@ -17,9 +17,9 @@ export declare const createInlineChangedDecoration: (change: {
 interface DeletedContentDecorationProps {
     change: Change;
     doc: PMNode;
-    tr: Transaction;
-    nodeViews: Record<string, NodeViewConstructor>;
     editorView?: EditorView;
+    nodeViews: Record<string, NodeViewConstructor>;
+    tr: Transaction;
 }
 /**
  * Creates a widget to represent the deleted content in the editor

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

@@ -6,10 +6,10 @@ import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { type DiffParams } from '../showDiffPluginType';
 export declare const showDiffPluginKey: PluginKey<ShowDiffPluginState>;
 type ShowDiffPluginState = {
-    steps: ProseMirrorStep[];
-    originalDoc: PMNode | undefined;
     decorations: DecorationSet;
     isDisplayingChanges: boolean;
+    originalDoc: PMNode | undefined;
+    steps: ProseMirrorStep[];
 };
 export declare const createPlugin: (config: DiffParams | undefined) => SafePlugin<ShowDiffPluginState>;
 export {};

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

@@ -4,26 +4,26 @@ import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
 export type DiffParams = {
+    originalDoc: JSONDocNode;
     /**
      * Prosemirror steps. This is used to calculate and show the diff in the editor
      */
     steps: StepJson[];
-    originalDoc: JSONDocNode;
 };
 export type PMDiffParams = {
+    originalDoc: Node;
     /**
      * Prosemirror steps. This is used to calculate and show the diff in the editor
      */
     steps: Step[];
-    originalDoc: Node;
 };
 export type ACTION = 'SHOW_DIFF' | 'HIDE_DIFF';
 export type ShowDiffPlugin = NextEditorPlugin<'showDiff', {
-    pluginConfiguration: DiffParams | undefined;
     commands: {
-        showDiff: (config: PMDiffParams) => EditorCommand;
         hideDiff: EditorCommand;
+        showDiff: (config: PMDiffParams) => EditorCommand;
     };
+    pluginConfiguration: DiffParams | undefined;
     sharedState: {
         /**
          * Whether the show diff feature is currently displaying changes.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "0.1.3",
+	"version": "0.1.5",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -37,7 +37,7 @@
 		"prosemirror-changeset": "^2.2.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.25.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {