@atlaskit/editor-plugin-list 5.1.6 → 5.1.7

package/CHANGELOG.md

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

package/dist/types/listPluginType.d.ts

@@ -7,19 +7,19 @@ export type ListPluginDependencies = [
     OptionalPlugin<AnalyticsPlugin>
 ];
 export type ListPluginActions = {
-    isInsideListItem: IsInsideListItem;
     findRootParentListNode: FindRootParentListNode;
+    isInsideListItem: IsInsideListItem;
 };
 export type ListPluginCommands = {
     indentList: IndentList;
     outdentList: OutdentList;
-    toggleOrderedList: ToggleOrderedList;
     toggleBulletList: ToggleBulletList;
+    toggleOrderedList: ToggleOrderedList;
 };
 export type ListPluginSharedState = ListState | undefined;
 export type ListPlugin = NextEditorPlugin<'list', {
-    dependencies: ListPluginDependencies;
     actions: ListPluginActions;
     commands: ListPluginCommands;
+    dependencies: ListPluginDependencies;
     sharedState: ListPluginSharedState;
 }>;

package/dist/types/pm-plugins/actions/conversions.d.ts

@@ -1,6 +1,6 @@
 import type { NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function convertListType({ tr, nextListNodeType, }: {
-    tr: Transaction;
     nextListNodeType: NodeType;
+    tr: Transaction;
 }): void;

package/dist/types/pm-plugins/actions/join-list-items-forward.d.ts

@@ -4,9 +4,9 @@ import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type ScenariosAllowed = LIST_TEXT_SCENARIOS.JOIN_PARAGRAPH_WITH_LIST | LIST_TEXT_SCENARIOS.JOIN_SIBLINGS | LIST_TEXT_SCENARIOS.JOIN_DESCENDANT_TO_PARENT | LIST_TEXT_SCENARIOS.JOIN_PARENT_SIBLING_TO_PARENT_CHILD | LIST_TEXT_SCENARIOS.JOIN_LIST_ITEM_WITH_PARAGRAPH;
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 type ScenarioAction = false | [ScenariosAllowed, DeleteAction];
 export declare const calcJoinListScenario: (walkNode: WalkNode, $head: ResolvedPos) => ScenarioAction;

package/dist/types/pm-plugins/actions/join-list-items-scenarios/join-list-item-with-paragraph.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinListItemWithParagraph: DeleteAction;
 export {};

package/dist/types/pm-plugins/actions/join-list-items-scenarios/join-list-item-with-parent-nested-list.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinListItemWithParentNestedList: DeleteAction;
 export {};

package/dist/types/pm-plugins/actions/join-list-items-scenarios/join-nested-list-with-parent-list-item.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinNestedListWithParentListItem: DeleteAction;
 export {};

package/dist/types/pm-plugins/actions/join-list-items-scenarios/join-paragraph-with-list.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinParagrapWithList: DeleteAction;
 export {};

package/dist/types/pm-plugins/actions/join-list-items-scenarios/join-sibling-list-items.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinSiblingListItems: DeleteAction;
 export {};

package/dist/types/pm-plugins/input-rules/create-list-input-rule.d.ts

@@ -1,9 +1,9 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { NodeType } from '@atlaskit/editor-prosemirror/model';
 type Props = {
-    listType: NodeType;
-    expression: RegExp;
     editorAnalyticsApi: EditorAnalyticsAPI | undefined;
+    expression: RegExp;
+    listType: NodeType;
 };
 export declare function createRuleForListType({ listType, expression, editorAnalyticsApi }: Props): import("@atlaskit/editor-common/types").InputRuleWrapper;
 export {};

package/dist/types/pm-plugins/input-rules/wrapping-join-rule.d.ts

@@ -3,10 +3,10 @@ import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import type { NodeType, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 type Attrs = Record<string, any>;
 type WrappingRuleProps = {
-    match: RegExp;
-    nodeType: NodeType;
     getAttrs?: Attrs | ((matchResult: RegExpExecArray) => Attrs);
     joinPredicate?: (matchResult: RegExpExecArray, node: PMNode, joinScenario: JOIN_SCENARIOS_WHEN_TYPING_TO_INSERT_LIST) => boolean;
+    match: RegExp;
+    nodeType: NodeType;
 };
 export declare const createWrappingJoinRule: ({ match, nodeType, getAttrs, joinPredicate, }: WrappingRuleProps) => InputRuleWrapper;
 export {};

package/dist/types/pm-plugins/utils/find.d.ts

@@ -1,10 +1,10 @@
 import type { Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 export declare function findFirstParentListNode($pos: ResolvedPos): {
-    pos: number;
     node: PMNode;
+    pos: number;
 } | null;
 export declare function findFirstParentListItemNode($pos: ResolvedPos): {
-    pos: number;
     node: PMNode;
+    pos: number;
 } | null;
 export declare const findRootParentListNode: ($pos: ResolvedPos) => ResolvedPos | null;

package/dist/types/pm-plugins/utils/mark.d.ts

@@ -1,8 +1,8 @@
 import type { Mark, Node, NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type NodesSanitized = Array<{
-    node: Node;
     marksRemoved: Mark[];
+    node: Node;
 }>;
 export declare const sanitiseMarksInSelection: (tr: Transaction, newParentType?: NodeType) => NodesSanitized;
 export {};

package/dist/types/types/index.d.ts

@@ -14,7 +14,7 @@ export type FindRootParentListNode = ($pos: ResolvedPos) => ResolvedPos | null;
 export interface ListState {
     bulletListActive: boolean;
     bulletListDisabled: boolean;
+    decorationSet: DecorationSet;
     orderedListActive: boolean;
     orderedListDisabled: boolean;
-    decorationSet: DecorationSet;
 }

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

@@ -7,19 +7,19 @@ export type ListPluginDependencies = [
     OptionalPlugin<AnalyticsPlugin>
 ];
 export type ListPluginActions = {
-    isInsideListItem: IsInsideListItem;
     findRootParentListNode: FindRootParentListNode;
+    isInsideListItem: IsInsideListItem;
 };
 export type ListPluginCommands = {
     indentList: IndentList;
     outdentList: OutdentList;
-    toggleOrderedList: ToggleOrderedList;
     toggleBulletList: ToggleBulletList;
+    toggleOrderedList: ToggleOrderedList;
 };
 export type ListPluginSharedState = ListState | undefined;
 export type ListPlugin = NextEditorPlugin<'list', {
-    dependencies: ListPluginDependencies;
     actions: ListPluginActions;
     commands: ListPluginCommands;
+    dependencies: ListPluginDependencies;
     sharedState: ListPluginSharedState;
 }>;

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

@@ -1,6 +1,6 @@
 import type { NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function convertListType({ tr, nextListNodeType, }: {
-    tr: Transaction;
     nextListNodeType: NodeType;
+    tr: Transaction;
 }): void;

package/dist/types-ts4.5/pm-plugins/actions/join-list-items-forward.d.ts

@@ -4,9 +4,9 @@ import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type ScenariosAllowed = LIST_TEXT_SCENARIOS.JOIN_PARAGRAPH_WITH_LIST | LIST_TEXT_SCENARIOS.JOIN_SIBLINGS | LIST_TEXT_SCENARIOS.JOIN_DESCENDANT_TO_PARENT | LIST_TEXT_SCENARIOS.JOIN_PARENT_SIBLING_TO_PARENT_CHILD | LIST_TEXT_SCENARIOS.JOIN_LIST_ITEM_WITH_PARAGRAPH;
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 type ScenarioAction = false | [
     ScenariosAllowed,

package/dist/types-ts4.5/pm-plugins/actions/join-list-items-scenarios/join-list-item-with-paragraph.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinListItemWithParagraph: DeleteAction;
 export {};

package/dist/types-ts4.5/pm-plugins/actions/join-list-items-scenarios/join-list-item-with-parent-nested-list.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinListItemWithParentNestedList: DeleteAction;
 export {};

package/dist/types-ts4.5/pm-plugins/actions/join-list-items-scenarios/join-nested-list-with-parent-list-item.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinNestedListWithParentListItem: DeleteAction;
 export {};

package/dist/types-ts4.5/pm-plugins/actions/join-list-items-scenarios/join-paragraph-with-list.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinParagrapWithList: DeleteAction;
 export {};

package/dist/types-ts4.5/pm-plugins/actions/join-list-items-scenarios/join-sibling-list-items.d.ts

@@ -1,9 +1,9 @@
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type DeleteAction = (props: {
-    tr: Transaction;
-    $next: ResolvedPos;
     $head: ResolvedPos;
+    $next: ResolvedPos;
+    tr: Transaction;
 }) => boolean;
 export declare const joinSiblingListItems: DeleteAction;
 export {};

package/dist/types-ts4.5/pm-plugins/input-rules/create-list-input-rule.d.ts

@@ -1,9 +1,9 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { NodeType } from '@atlaskit/editor-prosemirror/model';
 type Props = {
-    listType: NodeType;
-    expression: RegExp;
     editorAnalyticsApi: EditorAnalyticsAPI | undefined;
+    expression: RegExp;
+    listType: NodeType;
 };
 export declare function createRuleForListType({ listType, expression, editorAnalyticsApi }: Props): import("@atlaskit/editor-common/types").InputRuleWrapper;
 export {};

package/dist/types-ts4.5/pm-plugins/input-rules/wrapping-join-rule.d.ts

@@ -3,10 +3,10 @@ import type { InputRuleWrapper } from '@atlaskit/editor-common/types';
 import type { NodeType, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 type Attrs = Record<string, any>;
 type WrappingRuleProps = {
-    match: RegExp;
-    nodeType: NodeType;
     getAttrs?: Attrs | ((matchResult: RegExpExecArray) => Attrs);
     joinPredicate?: (matchResult: RegExpExecArray, node: PMNode, joinScenario: JOIN_SCENARIOS_WHEN_TYPING_TO_INSERT_LIST) => boolean;
+    match: RegExp;
+    nodeType: NodeType;
 };
 export declare const createWrappingJoinRule: ({ match, nodeType, getAttrs, joinPredicate, }: WrappingRuleProps) => InputRuleWrapper;
 export {};

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

@@ -1,10 +1,10 @@
 import type { Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
 export declare function findFirstParentListNode($pos: ResolvedPos): {
-    pos: number;
     node: PMNode;
+    pos: number;
 } | null;
 export declare function findFirstParentListItemNode($pos: ResolvedPos): {
-    pos: number;
     node: PMNode;
+    pos: number;
 } | null;
 export declare const findRootParentListNode: ($pos: ResolvedPos) => ResolvedPos | null;

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

@@ -1,8 +1,8 @@
 import type { Mark, Node, NodeType } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 type NodesSanitized = Array<{
-    node: Node;
     marksRemoved: Mark[];
+    node: Node;
 }>;
 export declare const sanitiseMarksInSelection: (tr: Transaction, newParentType?: NodeType) => NodesSanitized;
 export {};

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

@@ -14,7 +14,7 @@ export type FindRootParentListNode = ($pos: ResolvedPos) => ResolvedPos | null;
 export interface ListState {
     bulletListActive: boolean;
     bulletListDisabled: boolean;
+    decorationSet: DecorationSet;
     orderedListActive: boolean;
     orderedListDisabled: boolean;
-    decorationSet: DecorationSet;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-list",
-	"version": "5.1.6",
+	"version": "5.1.7",
 	"description": "List plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,11 +36,11 @@
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-input-rules": "^3.4.0",
-		"@atlaskit/tmp-editor-statsig": "^11.3.0",
+		"@atlaskit/tmp-editor-statsig": "^11.5.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.26.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},