@atlaskit/editor-plugin-code-block-advanced 3.2.1 → 3.2.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-code-block-advanced
 
+## 3.2.2
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 3.2.1
 
 ### Patch Changes

package/dist/types/codeBlockAdvancedPluginType.d.ts

@@ -16,6 +16,6 @@ export type CodeBlockAdvancedPlugin = NextEditorPlugin<'codeBlockAdvanced', {
     pluginConfiguration: CodeBlockAdvancedPluginOptions | undefined;
 }>;
 export type CodeBlockAdvancedPluginOptions = {
-    extensions?: Extension[];
     allowCodeFolding?: boolean;
+    extensions?: Extension[];
 };

package/dist/types/nodeviews/codeBlockAdvanced.d.ts

@@ -6,10 +6,10 @@ import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { Decoration, DecorationSource, EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
 import type { CodeBlockAdvancedPlugin } from '../codeBlockAdvancedPluginType';
 export interface ConfigProps {
+    allowCodeFolding: boolean;
     api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
     extensions: Extension[];
     getIntl: () => IntlShape;
-    allowCodeFolding: boolean;
 }
 declare class CodeBlockAdvancedNodeView implements NodeView {
     dom: Node;

package/dist/types/nodeviews/codemirrorSync/syncCMWithPM.d.ts

@@ -1,9 +1,9 @@
 import { type ViewUpdate } from '@codemirror/view';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 interface Props {
-    view: EditorView;
-    update: ViewUpdate;
     offset: number;
+    update: ViewUpdate;
+    view: EditorView;
 }
 /**
  *

package/dist/types/nodeviews/extensions/keymap/backspace.d.ts

@@ -3,10 +3,10 @@ import type { getPosHandlerNode } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 interface BackspaceProps {
-    view: EditorView;
     cm: CodeMirror;
-    getPos: getPosHandlerNode;
     getNode: () => PMNode;
+    getPos: getPosHandlerNode;
+    view: EditorView;
 }
 export declare const backspaceKeymap: ({ cm, view, getPos, getNode }: BackspaceProps) => boolean;
 export {};

package/dist/types/nodeviews/extensions/keymap/index.d.ts

@@ -4,12 +4,12 @@ import type { getPosHandlerNode } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 interface KeymapProps {
-    view: EditorView;
+    customFindReplace: boolean;
     getNode: () => PMNode;
     getPos: getPosHandlerNode;
-    selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
     onMaybeNodeSelection: () => void;
-    customFindReplace: boolean;
+    selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
+    view: EditorView;
 }
 export declare const keymapExtension: ({ view, getNode, getPos, selectCodeBlockNode, onMaybeNodeSelection, customFindReplace, }: KeymapProps) => Extension;
 export {};

package/dist/types/nodeviews/extensions/keymap/maybeEscape.d.ts

@@ -4,14 +4,14 @@ import type { getPosHandlerNode } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 interface MaybeEscapeProps {
-    unit: 'line' | 'char';
-    dir: -1 | 1;
-    view: EditorView;
     cm: CodeMirror;
-    getPos: getPosHandlerNode;
+    dir: -1 | 1;
     getNode: () => PMNode;
+    getPos: getPosHandlerNode;
     onMaybeNodeSelection: () => void;
     selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
+    unit: 'line' | 'char';
+    view: EditorView;
 }
 export declare const maybeEscapeKeymap: ({ unit, dir, view, cm, getPos, getNode, onMaybeNodeSelection, selectCodeBlockNode, }: MaybeEscapeProps) => boolean;
 export {};

package/dist/types/nodeviews/lazyCodeBlockAdvanced.d.ts

@@ -3,10 +3,10 @@ import type { IntlShape } from 'react-intl-next';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { CodeBlockAdvancedPlugin } from '../codeBlockAdvancedPluginType';
 interface Props {
+    allowCodeFolding: boolean;
     api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
     extensions: Extension[];
     getIntl: () => IntlShape;
-    allowCodeFolding: boolean;
 }
 export declare const lazyCodeBlockView: (props: Props) => import("@atlaskit/editor-common/lazy-node-view").NodeViewConstructor;
 export {};

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

@@ -4,10 +4,10 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { CodeBlockAdvancedPlugin } from '../codeBlockAdvancedPluginType';
 interface Props {
+    allowCodeFolding: boolean;
     api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
     extensions: Extension[];
     getIntl: () => IntlShape;
-    allowCodeFolding: boolean;
 }
 export declare const createPlugin: (props: Props) => SafePlugin<any>;
 export {};

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

@@ -16,6 +16,6 @@ export type CodeBlockAdvancedPlugin = NextEditorPlugin<'codeBlockAdvanced', {
     pluginConfiguration: CodeBlockAdvancedPluginOptions | undefined;
 }>;
 export type CodeBlockAdvancedPluginOptions = {
-    extensions?: Extension[];
     allowCodeFolding?: boolean;
+    extensions?: Extension[];
 };

package/dist/types-ts4.5/nodeviews/codeBlockAdvanced.d.ts

@@ -6,10 +6,10 @@ import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { Decoration, DecorationSource, EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
 import type { CodeBlockAdvancedPlugin } from '../codeBlockAdvancedPluginType';
 export interface ConfigProps {
+    allowCodeFolding: boolean;
     api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
     extensions: Extension[];
     getIntl: () => IntlShape;
-    allowCodeFolding: boolean;
 }
 declare class CodeBlockAdvancedNodeView implements NodeView {
     dom: Node;

package/dist/types-ts4.5/nodeviews/codemirrorSync/syncCMWithPM.d.ts

@@ -1,9 +1,9 @@
 import { type ViewUpdate } from '@codemirror/view';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 interface Props {
-    view: EditorView;
-    update: ViewUpdate;
     offset: number;
+    update: ViewUpdate;
+    view: EditorView;
 }
 /**
  *

package/dist/types-ts4.5/nodeviews/extensions/keymap/backspace.d.ts

@@ -3,10 +3,10 @@ import type { getPosHandlerNode } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 interface BackspaceProps {
-    view: EditorView;
     cm: CodeMirror;
-    getPos: getPosHandlerNode;
     getNode: () => PMNode;
+    getPos: getPosHandlerNode;
+    view: EditorView;
 }
 export declare const backspaceKeymap: ({ cm, view, getPos, getNode }: BackspaceProps) => boolean;
 export {};

package/dist/types-ts4.5/nodeviews/extensions/keymap/index.d.ts

@@ -4,12 +4,12 @@ import type { getPosHandlerNode } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 interface KeymapProps {
-    view: EditorView;
+    customFindReplace: boolean;
     getNode: () => PMNode;
     getPos: getPosHandlerNode;
-    selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
     onMaybeNodeSelection: () => void;
-    customFindReplace: boolean;
+    selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
+    view: EditorView;
 }
 export declare const keymapExtension: ({ view, getNode, getPos, selectCodeBlockNode, onMaybeNodeSelection, customFindReplace, }: KeymapProps) => Extension;
 export {};

package/dist/types-ts4.5/nodeviews/extensions/keymap/maybeEscape.d.ts

@@ -4,14 +4,14 @@ import type { getPosHandlerNode } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 interface MaybeEscapeProps {
-    unit: 'line' | 'char';
-    dir: -1 | 1;
-    view: EditorView;
     cm: CodeMirror;
-    getPos: getPosHandlerNode;
+    dir: -1 | 1;
     getNode: () => PMNode;
+    getPos: getPosHandlerNode;
     onMaybeNodeSelection: () => void;
     selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
+    unit: 'line' | 'char';
+    view: EditorView;
 }
 export declare const maybeEscapeKeymap: ({ unit, dir, view, cm, getPos, getNode, onMaybeNodeSelection, selectCodeBlockNode, }: MaybeEscapeProps) => boolean;
 export {};

package/dist/types-ts4.5/nodeviews/lazyCodeBlockAdvanced.d.ts

@@ -3,10 +3,10 @@ import type { IntlShape } from 'react-intl-next';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { CodeBlockAdvancedPlugin } from '../codeBlockAdvancedPluginType';
 interface Props {
+    allowCodeFolding: boolean;
     api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
     extensions: Extension[];
     getIntl: () => IntlShape;
-    allowCodeFolding: boolean;
 }
 export declare const lazyCodeBlockView: (props: Props) => import("@atlaskit/editor-common/lazy-node-view").NodeViewConstructor;
 export {};

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

@@ -4,10 +4,10 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { CodeBlockAdvancedPlugin } from '../codeBlockAdvancedPluginType';
 interface Props {
+    allowCodeFolding: boolean;
     api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
     extensions: Extension[];
     getIntl: () => IntlShape;
-    allowCodeFolding: boolean;
 }
 export declare const createPlugin: (props: Props) => SafePlugin<any>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-code-block-advanced",
-	"version": "3.2.1",
+	"version": "3.2.2",
 	"description": "CodeBlockAdvanced plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -35,11 +35,11 @@
 		"@atlaskit/editor-plugin-code-block": "^5.0.0",
 		"@atlaskit/editor-plugin-editor-disabled": "^3.0.0",
 		"@atlaskit/editor-plugin-find-replace": "^3.2.0",
-		"@atlaskit/editor-plugin-selection": "^3.1.0",
+		"@atlaskit/editor-plugin-selection": "^3.2.0",
 		"@atlaskit/editor-plugin-selection-marker": "^3.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^11.3.0",
+		"@atlaskit/tmp-editor-statsig": "^11.5.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@codemirror/autocomplete": "6.18.4",
@@ -55,7 +55,7 @@
 		"codemirror-lang-elixir": "4.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.26.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {

package/src/codeBlockAdvancedPluginType.ts

@@ -22,6 +22,6 @@ export type CodeBlockAdvancedPlugin = NextEditorPlugin<
 >;
 
 export type CodeBlockAdvancedPluginOptions = {
-	extensions?: Extension[];
 	allowCodeFolding?: boolean;
+	extensions?: Extension[];
 };

package/src/nodeviews/codeBlockAdvanced.ts

@@ -46,10 +46,10 @@ import { tripleClickSelectAllExtension } from './extensions/tripleClickExtension
 import { LanguageLoader } from './languages/loader';
 
 export interface ConfigProps {
+	allowCodeFolding: boolean;
 	api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
 	extensions: Extension[];
 	getIntl: () => IntlShape;
-	allowCodeFolding: boolean;
 }
 
 // Based on: https://prosemirror.net/examples/codemirror/

package/src/nodeviews/codemirrorSync/syncCMWithPM.ts

@@ -4,9 +4,9 @@ import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 
 interface Props {
-	view: EditorView;
-	update: ViewUpdate;
 	offset: number;
+	update: ViewUpdate;
+	view: EditorView;
 }
 
 /**

package/src/nodeviews/extensions/keymap/backspace.ts

@@ -6,10 +6,10 @@ import { TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 
 interface BackspaceProps {
-	view: EditorView;
 	cm: CodeMirror;
-	getPos: getPosHandlerNode;
 	getNode: () => PMNode;
+	getPos: getPosHandlerNode;
+	view: EditorView;
 }
 
 export const backspaceKeymap = ({ cm, view, getPos, getNode }: BackspaceProps) => {

package/src/nodeviews/extensions/keymap/index.ts

@@ -16,12 +16,12 @@ import { backspaceKeymap } from './backspace';
 import { maybeEscapeKeymap } from './maybeEscape';
 
 interface KeymapProps {
-	view: EditorView;
+	customFindReplace: boolean;
 	getNode: () => PMNode;
 	getPos: getPosHandlerNode;
-	selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
 	onMaybeNodeSelection: () => void;
-	customFindReplace: boolean;
+	selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
+	view: EditorView;
 }
 
 export const keymapExtension = ({

package/src/nodeviews/extensions/keymap/maybeEscape.ts

@@ -7,14 +7,14 @@ import { Selection } from '@atlaskit/editor-prosemirror/state';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 
 interface MaybeEscapeProps {
-	unit: 'line' | 'char';
-	dir: -1 | 1;
-	view: EditorView;
 	cm: CodeMirror;
-	getPos: getPosHandlerNode;
+	dir: -1 | 1;
 	getNode: () => PMNode;
+	getPos: getPosHandlerNode;
 	onMaybeNodeSelection: () => void;
 	selectCodeBlockNode: (relativeSelectionPos: RelativeSelectionPos | undefined) => void;
+	unit: 'line' | 'char';
+	view: EditorView;
 }
 
 export const maybeEscapeKeymap = ({
@@ -32,7 +32,7 @@ export const maybeEscapeKeymap = ({
 	}
 	const node = getNode();
 	const { state } = cm;
-	let main: { from: number; to: number; empty: boolean; head: number } = state.selection.main;
+	let main: { empty: boolean; from: number; head: number; to: number; } = state.selection.main;
 	if (!main.empty) {
 		return false;
 	}

package/src/nodeviews/extensions/prosemirrorDecorations.ts

@@ -30,12 +30,12 @@ type WidgetConstructor = ((view: EditorView, getPos: () => number | undefined) =
 // See: https://github.com/ProseMirror/prosemirror-view/blob/master/src/decoration.ts
 interface ExtendedProseMirrorDecoration extends Decoration {
 	inline: boolean;
-	widget: boolean;
 	type: {
 		attrs?: Record<string, string>;
-		toDOM?: WidgetConstructor;
 		side?: number;
+		toDOM?: WidgetConstructor;
 	};
+	widget: boolean;
 }
 
 // This type is not exposed publically by ProseMirror but we need it to map to CodeMirror

package/src/nodeviews/lazyCodeBlockAdvanced.ts

@@ -9,10 +9,10 @@ import type { EditorView, DecorationSource, Decoration } from '@atlaskit/editor-
 import type { CodeBlockAdvancedPlugin } from '../codeBlockAdvancedPluginType';
 
 interface Props {
+	allowCodeFolding: boolean;
 	api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
 	extensions: Extension[];
 	getIntl: () => IntlShape;
-	allowCodeFolding: boolean;
 }
 
 export const lazyCodeBlockView = (props: Props) => {

package/src/pm-plugins/main.ts

@@ -11,10 +11,10 @@ import { lazyCodeBlockView } from '../nodeviews/lazyCodeBlockAdvanced';
 import { shiftArrowDownWorkaround, shiftArrowUpWorkaround } from './shiftArrowKeyWorkaround';
 
 interface Props {
+	allowCodeFolding: boolean;
 	api: ExtractInjectionAPI<CodeBlockAdvancedPlugin> | undefined;
 	extensions: Extension[];
 	getIntl: () => IntlShape;
-	allowCodeFolding: boolean;
 }
 
 export const createPlugin = (props: Props) => {