@atlaskit/editor-plugin-list 1.0.0 → 1.1.2

package/dist/types/utils/selection.d.ts

@@ -1,11 +1,11 @@
 import type { NodeRange, NodeType, Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare const isPosInsideParagraph: ($pos: ResolvedPos) => boolean;
 export declare const isPosInsideList: ($pos: ResolvedPos) => boolean;
 export declare const isWrappingPossible: (nodeType: NodeType, selection: Selection) => boolean;
-export declare const isInsideListItem: (state: EditorState) => boolean;
-export declare const isInsideTableCell: (state: EditorState) => boolean;
-export declare const canJoinToPreviousListItem: (state: EditorState) => boolean;
+export declare const isInsideListItem: (tr: Transaction) => boolean;
+export declare const isInsideTableCell: (tr: Transaction) => boolean;
+export declare const canJoinToPreviousListItem: (tr: Transaction) => boolean;
 export declare const selectionContainsList: (tr: Transaction) => PMNode | null;
 type CreateNodeRange = (props: {
     selection: Selection;

package/dist/types-ts4.5/actions/outdent-list-items-selected.d.ts

@@ -1,3 +1,3 @@
 import type { FeatureFlags } from '@atlaskit/editor-common/types';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-export declare const outdentListItemsSelected: (tr: Transaction, state: EditorState, featureFlags: FeatureFlags) => void;
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const outdentListItemsSelected: (tr: Transaction, featureFlags: FeatureFlags) => void;

package/dist/types-ts4.5/commands/indent-list.d.ts

@@ -1,6 +1,6 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command } from '@atlaskit/editor-common/types';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
 type InputMethod = INPUT_METHOD.KEYBOARD | INPUT_METHOD.TOOLBAR;
-export declare const indentList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (inputMethod?: InputMethod) => Command;
+export declare const indentList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (inputMethod?: InputMethod) => EditorCommand;
 export {};

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

@@ -1,8 +1,7 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command, FeatureFlags } from '@atlaskit/editor-common/types';
+import type { Command, EditorCommand, FeatureFlags } from '@atlaskit/editor-common/types';
 import type { NodeType, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { indentList } from './indent-list';
 import { outdentList } from './outdent-list';
 export { outdentList, indentList };
@@ -11,6 +10,6 @@ export declare const enterKeyCommand: (editorAnalyticsAPI: EditorAnalyticsAPI |
 export declare const backspaceKeyCommand: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (featureFlags: FeatureFlags) => Command;
 export declare const deleteKeyCommand: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => Command;
 export declare const rootListDepth: (pos: ResolvedPos, nodes: Record<string, NodeType>) => number | undefined;
-export declare const toggleList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (inputMethod: InputMethod, listType: 'bulletList' | 'orderedList') => Command;
-export declare const toggleBulletList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (view: EditorView, inputMethod?: InputMethod) => boolean;
-export declare const toggleOrderedList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (view: EditorView, inputMethod?: InputMethod) => boolean;
+export declare const toggleList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (inputMethod: InputMethod, listType: 'bulletList' | 'orderedList') => EditorCommand;
+export declare const toggleBulletList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (inputMethod?: InputMethod) => EditorCommand;
+export declare const toggleOrderedList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (inputMethod?: InputMethod) => EditorCommand;

package/dist/types-ts4.5/commands/outdent-list.d.ts

@@ -1,6 +1,6 @@
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command, FeatureFlags } from '@atlaskit/editor-common/types';
+import type { EditorCommand, FeatureFlags } from '@atlaskit/editor-common/types';
 type InputMethod = INPUT_METHOD.KEYBOARD | INPUT_METHOD.TOOLBAR;
-export declare const outdentList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (inputMethod: InputMethod | undefined, featureFlags: FeatureFlags) => Command;
+export declare const outdentList: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (inputMethod: InputMethod | undefined, featureFlags: FeatureFlags) => EditorCommand;
 export {};

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

@@ -1,18 +1,18 @@
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { Command, FeatureFlags, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
-import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
-import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
+import type { EditorCommand, FeatureFlags, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { DecorationSet, EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 export type InputMethod = INPUT_METHOD.KEYBOARD | INPUT_METHOD.TOOLBAR;
 export declare const MAX_NESTED_LIST_INDENTATION = 6;
 export type ListPluginOptions = Pick<FeatureFlags, 'restartNumberedLists'>;
-export type IndentList = (inputMethod: InputMethod) => Command;
-export type OutdentList = (inputMethod: InputMethod, featureFlags: FeatureFlags) => Command;
-export type ToggleOrderedList = (view: EditorView, inputMethod: InputMethod) => boolean;
-export type ToggleBulletList = (view: EditorView, inputMethod: InputMethod) => boolean;
-export type IsInsideListItem = (state: EditorState) => boolean;
+export type IndentList = (inputMethod: InputMethod) => EditorCommand;
+export type OutdentList = (inputMethod: InputMethod) => EditorCommand;
+export type ToggleOrderedList = (inputMethod: InputMethod) => EditorCommand;
+export type ToggleBulletList = (inputMethod: InputMethod) => EditorCommand;
+export type IsInsideListItem = (tr: Transaction) => boolean;
 export type FindRootParentListNode = ($pos: ResolvedPos) => ResolvedPos | null;
 export interface ListState {
     bulletListActive: boolean;
@@ -24,16 +24,18 @@ export interface ListState {
 export type ListPlugin = NextEditorPlugin<'list', {
     pluginConfiguration: ListPluginOptions | undefined;
     dependencies: [
-        typeof featureFlagsPlugin,
-        OptionalPlugin<typeof analyticsPlugin>
+        FeatureFlagsPlugin,
+        OptionalPlugin<AnalyticsPlugin>
     ];
     actions: {
+        isInsideListItem: IsInsideListItem;
+        findRootParentListNode: FindRootParentListNode;
+    };
+    commands: {
         indentList: IndentList;
         outdentList: OutdentList;
         toggleOrderedList: ToggleOrderedList;
         toggleBulletList: ToggleBulletList;
-        isInsideListItem: IsInsideListItem;
-        findRootParentListNode: FindRootParentListNode;
     };
     sharedState: ListState | undefined;
 }>;

package/dist/types-ts4.5/utils/selection.d.ts

@@ -1,11 +1,11 @@
 import type { NodeRange, NodeType, Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare const isPosInsideParagraph: ($pos: ResolvedPos) => boolean;
 export declare const isPosInsideList: ($pos: ResolvedPos) => boolean;
 export declare const isWrappingPossible: (nodeType: NodeType, selection: Selection) => boolean;
-export declare const isInsideListItem: (state: EditorState) => boolean;
-export declare const isInsideTableCell: (state: EditorState) => boolean;
-export declare const canJoinToPreviousListItem: (state: EditorState) => boolean;
+export declare const isInsideListItem: (tr: Transaction) => boolean;
+export declare const isInsideTableCell: (tr: Transaction) => boolean;
+export declare const canJoinToPreviousListItem: (tr: Transaction) => boolean;
 export declare const selectionContainsList: (tr: Transaction) => PMNode | null;
 type CreateNodeRange = (props: {
     selection: Selection;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-list",
-  "version": "1.0.0",
+  "version": "1.1.2",
   "description": "List plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -31,8 +31,8 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/adf-schema": "^28.1.0",
-    "@atlaskit/editor-common": "^74.50.0",
+    "@atlaskit/adf-schema": "28.1.2",
+    "@atlaskit/editor-common": "^74.52.0",
     "@atlaskit/editor-plugin-analytics": "^0.1.0",
     "@atlaskit/editor-plugin-feature-flags": "^0.1.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
@@ -45,7 +45,6 @@
   },
   "devDependencies": {
     "@af/visual-regression": "*",
-    "@atlaskit/editor-test-helpers": "^18.11.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@testing-library/react": "^12.1.5",
     "react-dom": "^16.8.0",

package/report.api.md

@@ -15,46 +15,44 @@
 <!--SECTION START: Main Entry Types-->
 
 ```ts
-import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
-import type { Command } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { FeatureFlags } from '@atlaskit/editor-common/types';
-import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 
 // @public (undocumented)
 export type FindRootParentListNode = ($pos: ResolvedPos) => ResolvedPos | null;
 
 // @public (undocumented)
-type IndentList = (inputMethod: InputMethod) => Command;
+type IndentList = (inputMethod: InputMethod) => EditorCommand;
 
 // @public (undocumented)
 export type InputMethod = INPUT_METHOD.KEYBOARD | INPUT_METHOD.TOOLBAR;
 
 // @public (undocumented)
-type IsInsideListItem = (state: EditorState) => boolean;
+type IsInsideListItem = (tr: Transaction) => boolean;
 
 // @public (undocumented)
 export type ListPlugin = NextEditorPlugin<
   'list',
   {
     pluginConfiguration: ListPluginOptions | undefined;
-    dependencies: [
-      typeof featureFlagsPlugin,
-      OptionalPlugin<typeof analyticsPlugin>,
-    ];
+    dependencies: [FeatureFlagsPlugin, OptionalPlugin<AnalyticsPlugin>];
     actions: {
+      isInsideListItem: IsInsideListItem;
+      findRootParentListNode: FindRootParentListNode;
+    };
+    commands: {
       indentList: IndentList;
       outdentList: OutdentList;
       toggleOrderedList: ToggleOrderedList;
       toggleBulletList: ToggleBulletList;
-      isInsideListItem: IsInsideListItem;
-      findRootParentListNode: FindRootParentListNode;
     };
     sharedState: ListState | undefined;
   }
@@ -81,19 +79,13 @@ export interface ListState {
 }
 
 // @public (undocumented)
-type OutdentList = (
-  inputMethod: InputMethod,
-  featureFlags: FeatureFlags,
-) => Command;
+type OutdentList = (inputMethod: InputMethod) => EditorCommand;
 
 // @public (undocumented)
-type ToggleBulletList = (view: EditorView, inputMethod: InputMethod) => boolean;
+type ToggleBulletList = (inputMethod: InputMethod) => EditorCommand;
 
 // @public (undocumented)
-type ToggleOrderedList = (
-  view: EditorView,
-  inputMethod: InputMethod,
-) => boolean;
+type ToggleOrderedList = (inputMethod: InputMethod) => EditorCommand;
 
 // (No @packageDocumentation comment for this package)
 ```

package/tmp/api-report-tmp.d.ts

@@ -1,80 +0,0 @@
-## API Report File for "@atlaskit/editor-plugin-list"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
-import type { Command } from '@atlaskit/editor-common/types';
-import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { FeatureFlags } from '@atlaskit/editor-common/types';
-import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
-import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
-import type { OptionalPlugin } from '@atlaskit/editor-common/types';
-import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
-
-// @public (undocumented)
-export type FindRootParentListNode = ($pos: ResolvedPos) => ResolvedPos | null;
-
-// @public (undocumented)
-type IndentList = (inputMethod: InputMethod) => Command;
-
-// @public (undocumented)
-export type InputMethod = INPUT_METHOD.KEYBOARD | INPUT_METHOD.TOOLBAR;
-
-// @public (undocumented)
-type IsInsideListItem = (state: EditorState) => boolean;
-
-// @public (undocumented)
-export type ListPlugin = NextEditorPlugin<'list', {
-    pluginConfiguration: ListPluginOptions | undefined;
-    dependencies: [
-    typeof featureFlagsPlugin,
-    OptionalPlugin<typeof analyticsPlugin>
-    ];
-    actions: {
-        indentList: IndentList;
-        outdentList: OutdentList;
-        toggleOrderedList: ToggleOrderedList;
-        toggleBulletList: ToggleBulletList;
-        isInsideListItem: IsInsideListItem;
-        findRootParentListNode: FindRootParentListNode;
-    };
-    sharedState: ListState | undefined;
-}>;
-
-// @public (undocumented)
-export const listPlugin: ListPlugin;
-
-// @public (undocumented)
-export type ListPluginOptions = Pick<FeatureFlags, 'restartNumberedLists'>;
-
-// @public (undocumented)
-export interface ListState {
-    // (undocumented)
-    bulletListActive: boolean;
-    // (undocumented)
-    bulletListDisabled: boolean;
-    // (undocumented)
-    decorationSet: DecorationSet;
-    // (undocumented)
-    orderedListActive: boolean;
-    // (undocumented)
-    orderedListDisabled: boolean;
-}
-
-// @public (undocumented)
-type OutdentList = (inputMethod: InputMethod, featureFlags: FeatureFlags) => Command;
-
-// @public (undocumented)
-type ToggleBulletList = (view: EditorView, inputMethod: InputMethod) => boolean;
-
-// @public (undocumented)
-type ToggleOrderedList = (view: EditorView, inputMethod: InputMethod) => boolean;
-
-// (No @packageDocumentation comment for this package)
-
-```