@witchcraft/layout 0.4.4 → 0.5.1

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

@@ -72,17 +72,17 @@ export declare const zEdge: z.ZodObject<{
     } | {
         frame: LayoutFrame;
     } | {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     } | {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     } | {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     } | {
         frame: LayoutFrame;
     } | {
@@ -131,17 +131,17 @@ export declare const zEdge: z.ZodObject<{
     } | {
         frame: LayoutFrame;
     } | {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     } | {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     } | {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     } | {
         frame: LayoutFrame;
     } | {
@@ -475,17 +475,17 @@ declare const zLayoutShape: z.ZodDiscriminatedUnion<[z.ZodObject<{
         } | {
             frame: LayoutFrame;
         } | {
-            draggingFrameId: string;
+            movingFrameId: string;
             hoveredFrameId: string;
-            zoneSide: DragZone["side"];
+            zoneSide: Zone["side"];
         } | {
-            draggingFrameId: string;
+            movingFrameId: string;
             hoveredFrameId: string;
-            zoneSide: DragZone["side"];
+            zoneSide: Zone["side"];
         } | {
-            draggingFrameId: string;
+            movingFrameId: string;
             hoveredFrameId: string;
-            zoneSide: DragZone["side"];
+            zoneSide: Zone["side"];
         } | {
             frame: LayoutFrame;
         } | {
@@ -534,17 +534,17 @@ declare const zLayoutShape: z.ZodDiscriminatedUnion<[z.ZodObject<{
         } | {
             frame: LayoutFrame;
         } | {
-            draggingFrameId: string;
+            movingFrameId: string;
             hoveredFrameId: string;
-            zoneSide: DragZone["side"];
+            zoneSide: Zone["side"];
         } | {
-            draggingFrameId: string;
+            movingFrameId: string;
             hoveredFrameId: string;
-            zoneSide: DragZone["side"];
+            zoneSide: Zone["side"];
         } | {
-            draggingFrameId: string;
+            movingFrameId: string;
             hoveredFrameId: string;
-            zoneSide: DragZone["side"];
+            zoneSide: Zone["side"];
         } | {
             frame: LayoutFrame;
         } | {
@@ -618,17 +618,17 @@ declare const zBaseDeco: z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -677,17 +677,17 @@ declare const zBaseDeco: z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -762,17 +762,17 @@ export declare const zSplitDeco: z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -821,17 +821,17 @@ export declare const zSplitDeco: z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -927,17 +927,17 @@ declare const zCloseDeco: z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -986,17 +986,17 @@ declare const zCloseDeco: z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1033,7 +1033,7 @@ declare const zCloseDeco: z.ZodObject<{
     force: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export type CloseDeco = z.infer<typeof zCloseDeco>;
-declare const zFrameDragDeco: z.ZodObject<{
+declare const zFrameDeco: z.ZodObject<{
     shapes: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
         type: z.ZodLiteral<"rect">;
         data: z.ZodObject<{
@@ -1074,17 +1074,17 @@ declare const zFrameDragDeco: z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1133,17 +1133,17 @@ declare const zFrameDragDeco: z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1186,7 +1186,7 @@ declare const zFrameDragDeco: z.ZodObject<{
         center: "center";
     }>]>;
 }, z.core.$strip>;
-export type FrameDragDeco = z.infer<typeof zFrameDragDeco>;
+export type FrameDeco = z.infer<typeof zFrameDeco>;
 export declare const zDeco: z.ZodUnion<readonly [z.ZodObject<{
     shapes: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
         type: z.ZodLiteral<"rect">;
@@ -1228,17 +1228,17 @@ export declare const zDeco: z.ZodUnion<readonly [z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1287,17 +1287,17 @@ export declare const zDeco: z.ZodUnion<readonly [z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1379,17 +1379,17 @@ export declare const zDeco: z.ZodUnion<readonly [z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1438,17 +1438,17 @@ export declare const zDeco: z.ZodUnion<readonly [z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1524,17 +1524,17 @@ export declare const zDeco: z.ZodUnion<readonly [z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1583,17 +1583,17 @@ export declare const zDeco: z.ZodUnion<readonly [z.ZodObject<{
             } | {
                 frame: LayoutFrame;
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
-                draggingFrameId: string;
+                movingFrameId: string;
                 hoveredFrameId: string;
-                zoneSide: DragZone["side"];
+                zoneSide: Zone["side"];
             } | {
                 frame: LayoutFrame;
             } | {
@@ -1703,19 +1703,19 @@ export type LayoutErrorsInfo = {
         frame: LayoutFrame;
     };
     [LAYOUT_ERROR.CANT_REARRANGE_TO_SAME_RELATIVE_POSITION]: {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     };
     [LAYOUT_ERROR.CANT_REARRANGE_WITH_DOCKED_EDGES]: {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     };
     [LAYOUT_ERROR.CANT_REARRANGE_DOCKED_WITH_NON_DOCKED]: {
-        draggingFrameId: string;
+        movingFrameId: string;
         hoveredFrameId: string;
-        zoneSide: DragZone["side"];
+        zoneSide: Zone["side"];
     };
     [LAYOUT_ERROR.CANT_SPLIT_DOCKED_FRAME]: {
         frame: LayoutFrame;
@@ -1755,7 +1755,7 @@ export type LayoutErrorsInfo = {
     };
 };
 export type HasOpposite = Direction | EdgeSide | ExtendedDirection | ExtendedEdgeSide | keyof Point | keyof Size;
-export type BaseDragZone = {
+export type BaseZone = {
     x: number;
     y: number;
     width: number;
@@ -1763,15 +1763,15 @@ export type BaseDragZone = {
     pxWidth: number;
     pxHeight: number;
 };
-export type FrameDragZone = BaseDragZone & {
+export type FrameZone = BaseZone & {
     type: "frame";
     side: EdgeSide | "center";
 };
-export type WindowEdgeZone = BaseDragZone & {
+export type WindowEdgeZone = BaseZone & {
     type: "window";
     side: EdgeSide;
 };
-export type DragZone = FrameDragZone | WindowEdgeZone;
+export type Zone = FrameZone | WindowEdgeZone;
 export declare const zWindowCreate: z.ZodObject<{
     id: z.ZodOptional<z.ZodUUID>;
     activeFrame: z.ZodOptional<z.ZodString>;
@@ -1843,33 +1843,33 @@ export type LayoutChange<TInfo = never> = {
     window?: Partial<LayoutWindow>;
     info?: TInfo;
 };
-export type DragState = {
+export type MoveState = {
     /** The current directions in the corresponding orientations that the user is dragging in. */
-    dragDirections: Record<Orientation, Direction | undefined>;
+    moveDirections: Record<Orientation, Direction | undefined>;
     /** The curren point (in scaled window coordinates) the user is dragging at. */
-    dragPoint?: Point;
+    movePoint?: Point;
     /** Cumulative pixel distance the user has dragged from the initial click point. 0 on start, increases on each move. */
-    dragDistance: number;
+    moveDistance: number;
     /** Whether the user is currently dragging and what type of drag. Is truthy string during all drag events. */
-    isDragging: boolean | "frame" | "edge";
+    isMoving: boolean | "frame" | "edge";
     /** Whether to show the moved frames while dragging. */
-    showDragging: boolean;
-    /** The frame being dragged during a frame drag. Only set when isDragging is "frame". */
-    draggingFrameId?: FrameId;
+    showMoving: boolean;
+    /** The frame being dragged during a frame drag. Only set when isMoving is "frame". */
+    movingFrameId?: FrameId;
     /**
      * The edges that are currently being dragged. There are multiple edges if they drag an intersection since what's actually happening is we're just dragging the closest horizontal and vertical edges.
      */
-    draggingEdges: Edge[];
+    movingEdges: Edge[];
     /**
      * The intersection that is currently being dragged.
      */
-    draggingIntersection?: IntersectionEntry;
+    movingIntersection?: IntersectionEntry;
     /** The "visual" edges that can be displayed for dragging. See {@link getVisualEdges} */
     visualEdges: Edge[];
     /**
      * The frames touching the currently dragged edges. Each entry corresponds to the frames touching the corresponding dragging edge.
      *
-     * So you can use the index in draggingEdges to get the corresponding frames.
+     * So you can use the index in movingEdges to get the corresponding frames.
      */
     touchingFrames: Record<string, LayoutFrame>[];
     /**
@@ -1877,13 +1877,13 @@ export type DragState = {
      */
     touchingFramesArrays: LayoutFrame[][];
     /**
-     * All the frames, with/without the currently dragged frames depending on if `showDragging` is true.
+     * All the frames, with/without the currently dragged frames depending on if `showMoving` is true.
      */
     frames: Record<string, LayoutFrame>;
     /**
-     * The frame that is currently being hovered over (according to whether `dragPoint` in in the frame or not).
+     * The frame that is currently being hovered over (according to whether `movePoint` in in the frame or not).
      */
-    dragHoveredFrame: LayoutFrame | undefined;
+    moveHoveredFrame: LayoutFrame | undefined;
     /**
      * A list of corner intersections. Frames can also be dragged by these.
      */
@@ -1891,28 +1891,39 @@ export type DragState = {
     /**
      * Whether the drag was initiated from a point along the window edge.
      */
-    isDraggingFromWindowEdge: boolean;
-    /** Custom context passed to dragStart, available to action handlers via state.eventContext. */
+    isMovingFromWindowEdge: boolean;
+    /** Custom context passed to moveStart, available to action handlers via state.eventContext. */
     eventContext?: Record<string, unknown>;
     win: LayoutWindow;
 };
-export interface ActionDragChangeResult {
+export interface ActionChangeResult {
     /** Whether the drag should update the edges. Defaults to false. */
     updateEdges?: boolean;
     /** Deco shapes produced by this action during this drag step. */
     shapes: LayoutShape[];
     /** Whether to show the moved edges while dragging. Defaults to true. */
-    showDragging?: boolean;
+    showMoving?: boolean;
 }
-export type DragChangeResult = Omit<ActionDragChangeResult, "shapes">;
+export type MoveChangeResult = Omit<ActionChangeResult, "shapes">;
 /**
  * Called when the drag coordinates change (during any event).
  *
  * Should return `{ allowed: true/false, shapes: LayoutShape[] }` to control whether the action is allowed and edges update and what deco shapes to render.
  *
  * Note that the allowed return type only affect the `move` event but is also typed as `boolean` for other events for ease of use.
+ *
+ * Use also to cleanup your action when type is "end".
+ *
+ * See also {@link ActionHandler.onMoveChange} to understand it's lifecycle as it is the extended version of.
  */
-export type DragChangeHandler = <T extends "start" | "move" | "end">(type: T, e: T extends "end" ? PointerEvent | undefined : PointerEvent, state: DragState, forceRecalculateEdges: () => void, cancel: (e: PointerEvent | KeyboardEvent | undefined, state: DragState) => void) => ActionDragChangeResult;
+export type MoveChangeHandler = <T extends "start" | "move" | "end">(type: T, e: T extends "end" ? PointerEvent | undefined : PointerEvent, state: MoveState, forceRecalculateEdges: () => void, 
+/** Calls moveEnd with apply: false. This can technically be called from "end", it should still work. */
+cancel: (e: PointerEvent | KeyboardEvent | undefined, state: MoveState) => void, 
+/** Saves result to resolve moveStart promise with then calls moveEnd with given apply. Not available during "end" event. It's designed for resolving from other external evente (e.g. key events). */
+resolve: T extends "end" ? undefined : ({ apply, result }: {
+    apply: boolean;
+    result: any;
+}) => void) => ActionChangeResult;
 /**
  * A drag action describes when and how to handle a drag event.
  *
@@ -1920,19 +1931,21 @@ export type DragChangeHandler = <T extends "start" | "move" | "end">(type: T, e:
  *
  * Each action should handle it's configuration and saving/caching any state it needs. See {@link SplitAction} and {@link CloseAction} for examples.
  */
-export interface IDragAction {
+export interface IAction {
     /** A unique name for your action. */
     name: string;
-    onDragChange: DragChangeHandler;
+    onMoveChange: MoveChangeHandler;
     /**
      *
-     * Is called after `onDragChange("end")` with the same event. Might not be called if the request was cancelled.
+     * Is called before `onMoveChange("end")` with the same event. Might not be called if the request was cancelled.
      *
      * You should apply your action if possible and return whether it was applied.
      *
-     * This is also a good place to reset your state.
+     * Do not reset state here, use onMoveChange ("end").
+     *
+     * See also {@link ActionHandler.onMoveApply} which this is the extended version of.
      */
-    onDragApply: (state: DragState, forceRecalculateEdges: () => void) => boolean;
+    onMoveApply: (state: MoveState, forceRecalculateEdges: () => void) => boolean;
     /**
      * Should return true if it should handle the "request"/event (e.g. some modifier is being pressed => user is requesting x action).
      *
@@ -1940,20 +1953,14 @@ export interface IDragAction {
      *
      * Here is where you should initiate your state. Don't allow the action by default unless it can always be allowed.
      */
-    canHandleRequest(e: KeyboardEvent | PointerEvent, state: DragState, forceRecalculateEdges: () => void): boolean;
-    /**
-     * Called when a user cancels the drag action.
-     *
-     * You should reset your state here.
-     */
-    cancel(e: PointerEvent | KeyboardEvent | undefined, state: DragState): void;
+    canHandleRequest(e: KeyboardEvent | PointerEvent, state: MoveState, forceRecalculateEdges: () => void): boolean;
     /**
-     * Plugins should implement some basic debug logs by calling {@link DragActionHandler.debugState } at least before and after applying actions in onDragApply. Debug can be a string because it can be an object key to filter on (see the debugState function).
+     * Plugins should implement some basic debug logs by calling {@link ActionHandler.debugState } at least before and after applying actions in onMoveApply. Debug can be a string because it can be an object key to filter on (see the debugState function).
      *
      *
      * Calls look like this usually, where this.state is the plugin state:
      * ```ts
-     * DragActionHandler.debugState(this.name, "before", state, this.state, this.debug)
+     * ActionHandler.debugState(this.name, "before", state, this.state, this.debug)
      * ```
      */
     debug: boolean | string;
@@ -1970,6 +1977,10 @@ export interface IDragAction {
         /** Error texts/hints to display when the action produces an error. */
         errors?: string[];
     };
+    /**
+     * Called when an action is cancelled. Call action specific onCancel hooks here.
+     */
+    cancel(e: PointerEvent | KeyboardEvent | undefined, state: MoveState): void;
     /**
      * Called after visual edges are recalculated, once per edge. Action handlers can annotate edges with error info here ({@link Edge.error}).
      *
@@ -1991,43 +2002,53 @@ export interface IDragAction {
      */
     annotateEdge?(edge: Edge, frames: LayoutFrame[]): void;
 }
-export type EdgeDragStartData = {
+export type EdgeMoveStartData = {
     edge?: Edge;
     intersection?: IntersectionEntry;
 };
-export type FrameDragStartData = {
+export type FrameMoveStartData = {
     frameId: FrameId;
 };
+export type ActionHandlerApplyResult = {
+    /** Whether to apply the regular drag end changes. Return false to reset to the position before dragging. */
+    apply: boolean;
+    /** Value to resolve the drag promise with. Ignored if `apply` is false. */
+    result: any;
+};
 /**
  * Handler interface for drag actions.
  */
 export interface ActionHandler {
-    eventHandler: (e: KeyboardEvent, state: DragState, forceRecalculateEdges: () => void) => void;
+    eventHandler: (e: KeyboardEvent, state: MoveState, forceRecalculateEdges: () => void) => void;
     /**
-     * Called when the drag coordinates change (during any event). Should return true to allow the edges to be updated/moved, or false to prevent it.
+     * Called when the drag coordinates change (during any event). Should return true to allow the edges to be updated/moved, or false to prevent it. See also {@link MoveChangeHandler} for the built in action handler.
      *
-     * Can return anything for the end event as it's ignored.
+     * Can be used to save some context/info to later apply safely during onMoveApply.
      *
-     * Can be used to save some context/info to later apply safely during onDragApply.
+     * The call order is:
+     * - onMoveChange("start", ...)
+     * - onMoveChange("move", ...)
+     * - onMoveChange("end", ...)
+     * - onMoveApply(...) (IF moveEnd was called with apply: true, otherwise this is skipped)
+     * - onMoveEnded() // do cleanup here
      */
-    onDragChange: (...args: Parameters<DragChangeHandler>) => DragChangeResult;
+    onMoveChange: (...args: Parameters<MoveChangeHandler>) => MoveChangeResult;
     /**
-     * Called when drag will be applied. If dragEnd was called with apply false, it will not be called.
+     * Called when drag will be applied. If moveEnd was called with apply false, it will not be called.
      * Return false to not apply the regular drag end changes (i.e. return false to reset to the position before dragging).
+     *
+     * Do not use for resetting handler state, use onMoveEnded for that.
      */
-    onDragApply: (state: DragState, forceRecalculateEdges: () => void) => {
-        /** Whether to apply the regular drag end changes. Return false to reset to the position before dragging. */
-        apply: boolean;
-        /** Value to resolve the drag promise with. Ignored if `apply` is false. */
-        result: any;
-    };
+    onMoveApply: (state: MoveState, forceRecalculateEdges: () => void) => ActionHandlerApplyResult;
+    /** For doing cleanup */
+    onMoveEnded: () => void;
     /**
      * Called after visual edges are recalculated. Action handlers can annotate edges with error info.
      */
     annotateEdges?: (edges: Edge[], frames: LayoutFrame[]) => void;
 }
-export type DragStartFn = {
-    (e: PointerEvent, type: "edge", data: EdgeDragStartData): void;
-    (e: PointerEvent, type: "frame", data: FrameDragStartData): void;
+export type MoveStartFn = {
+    (e: PointerEvent, type: "edge", data: EdgeMoveStartData): void;
+    (e: PointerEvent, type: "frame", data: FrameMoveStartData): void;
 };
 export type * from "./vue.js";