@snapgridjs/dnd 0.4.0

package/dist/index.d.cts

@@ -0,0 +1,261 @@
+import { Compactor, DragSession, GridConfig, Layout, LayoutItem, PositionParams, ResizeHandleAxis } from "@snapgridjs/core";
+import { Modifier, Modifiers, Sensors } from "@dnd-kit/abstract";
+import { DragDropManager, Feedback, Sensors as Sensors$1 } from "@dnd-kit/dom";
+import { CollisionDetector } from "@dnd-kit/collision";
+
+//#region src/types.d.ts
+/**
+ * Drag behaviour configuration (mirrors react-grid-layout v2's `dragConfig`).
+ * The interaction itself is driven by dnd-kit.
+ */
+interface DragConfig {
+  /** Whether items can be dragged. @default true */
+  enabled?: boolean;
+  /** Keep the dragged item within the grid container bounds. @default false */
+  bounded?: boolean;
+  /** CSS selector for a drag handle inside each item. */
+  handle?: string;
+  /** CSS selector for regions that should cancel a drag. */
+  cancel?: string;
+  /** Pixels the pointer must move before a drag starts. @default 3 */
+  threshold?: number;
+  /**
+   * snapgrid extra: snap the dragged tile itself to grid cells while dragging.
+   * When `false` (the default, matching react-grid-layout) the tile follows the
+   * pointer smoothly and only the placeholder snaps.
+   */
+  snapToGrid?: boolean;
+}
+/**
+ * Resize behaviour configuration (mirrors react-grid-layout v2's `resizeConfig`).
+ */
+interface ResizeConfig {
+  /** Whether items can be resized. @default true */
+  enabled?: boolean;
+  /** Which handles to show on each item (item-level `resizeHandles` overrides). @default ['se'] */
+  handles?: ResizeHandleAxis[];
+}
+/** Minimal source shape passed to a {@link DropConfig.accept} predicate. */
+interface DragSourceInfo {
+  id: string | number;
+  type?: unknown;
+  data?: unknown;
+}
+/**
+ * Accept arbitrary (non-grid) dnd-kit draggables dropped into the grid. The
+ * external draggable should carry `data.snapGridDrop = { i?, w?, h? }` to control
+ * the inserted item's id/size; otherwise `defaultItem` is used. On drop the grid
+ * fires `onDrop(layout, item, event)` rather than `onLayoutChange`.
+ *
+ * Requires the grid and the external draggable to share one provider
+ * (e.g. both inside a `<SnapGridGroup>`).
+ */
+interface DropConfig {
+  /** Accept external draggables. @default false */
+  enabled?: boolean;
+  /** Default size for a dropped item when the source omits `snapGridDrop`. @default { w: 1, h: 1 } */
+  defaultItem?: {
+    w: number;
+    h: number;
+  };
+  /** Restrict which external sources are accepted. @default accept any non-grid draggable */
+  accept?: (source: DragSourceInfo) => boolean;
+}
+/** The `data.snapGridDrop` payload an external draggable carries to drop into a grid. */
+interface GridDropData {
+  /** Id for the inserted item (a unique one is generated if omitted). */
+  i?: string;
+  /** Width in grid units. */
+  w?: number;
+  /** Height in grid units. */
+  h?: number;
+}
+/**
+ * react-grid-layout-compatible lifecycle callback.
+ * `(layout, oldItem, newItem, placeholder, event, node)`
+ */
+type GridEventCallback = (layout: Layout, oldItem: LayoutItem | null, newItem: LayoutItem | null, placeholder: LayoutItem | null, event: Event | null, node: HTMLElement | null) => void;
+//#endregion
+//#region src/dnd/dragData.d.ts
+/**
+ * Data attached to the dnd-kit draggables snapgrid creates. `group` is the owning
+ * grid's id, so the centralized {@link SnapGridEngine} can resolve the source
+ * grid's controller from the drag payload (one engine drives every grid).
+ */
+type SnapGridDragData = {
+  kind: "move";
+  itemId: string;
+  item: LayoutItem;
+  group: string;
+} | {
+  kind: "resize";
+  itemId: string;
+  handle: ResizeHandleAxis;
+  group: string;
+};
+//#endregion
+//#region src/controller/GridController.d.ts
+/**
+ * The per-grid drag/resize callbacks the consumer supplied. Published to the
+ * controller so the shared {@link SnapGridEngine} can invoke the RIGHT grid's
+ * callbacks at the right phase (the engine is manager-wide; callbacks are per-grid).
+ */
+interface GridCallbacks {
+  onDragStart?: GridEventCallback;
+  onDrag?: GridEventCallback;
+  onDragStop?: GridEventCallback;
+  onResizeStart?: GridEventCallback;
+  onResize?: GridEventCallback;
+  onResizeStop?: GridEventCallback;
+  onLayoutChange?: (layout: Layout) => void;
+  onDrop?: (layout: Layout, item: LayoutItem, event: Event | null) => void;
+}
+/**
+ * Per-grid configuration the container host writes to the controller each render
+ * (during render, so items that resolve this controller by `group` read fresh
+ * config on the same pass). Also the seam the manager-wide {@link SnapGridEngine}
+ * reads per-grid geometry, compaction, gates, and callbacks from.
+ */
+interface GridControllerConfig {
+  positionParams: PositionParams;
+  gridConfig: GridConfig;
+  width: number;
+  autoSize: boolean;
+  itemSensors: Sensors;
+  itemModifiers: Modifiers;
+  isItemDraggable: (id: string) => boolean;
+  isItemResizable: (id: string) => boolean;
+  resizeHandlesFor: (id: string) => readonly ResizeHandleAxis[];
+  compactor: Compactor;
+  dragConfig?: DragConfig;
+  dropConfig?: DropConfig;
+  callbacks: GridCallbacks;
+}
+interface ItemSnapshot {
+  item: LayoutItem | undefined;
+  isDragging: boolean;
+  hidden: boolean;
+}
+interface ResizeSnapshot {
+  isResizing: boolean;
+}
+/**
+ * Live per-grid drag/resize state as a plain observable: the provider writes
+ * (`setSession`/`setKeyboard`/`setCommitted`), hooks subscribe to just their own
+ * slice via `useSyncExternalStore`. Value-cached snapshots mean a drag re-renders
+ * only the tiles whose slice changed, not the whole subtree (the old
+ * context-value model re-rendered every tile every frame).
+ */
+declare class GridController {
+  #private;
+  id: string;
+  config: GridControllerConfig | null;
+  /** The dnd-kit manager this grid is registered with (set by useInstance). */
+  manager: DragDropManager | undefined;
+  /**
+   * This grid's container element, reported by the host. The engine reads it to
+   * map a pointer to a cell when receiving a tile (its `getBoundingClientRect`).
+   */
+  element: Element | null;
+  constructor(id: string, committed?: Layout, manager?: DragDropManager);
+  /** The committed (base) layout — the engine's source of truth during a drag. */
+  getCommitted(): Layout;
+  /** Replace the per-grid config (called by the container host during render). */
+  setConfig(config: GridControllerConfig): void;
+  /**
+   * Re-point this grid's id. The container host syncs it (during render, before
+   * the droppable/group read it) when the controlled `id` prop changes, so the
+   * returned `group`, the droppable id, and the registry key never drift apart.
+   */
+  setId(id: string): void;
+  register: () => void;
+  subscribe: (listener: () => void) => (() => void);
+  /**
+   * Sync the committed layout from the controlled `layout` prop. Called during
+   * the provider's render, so it must NOT notify — emitting here would update
+   * subscribed GridItems mid-render (a React "setState while rendering" error).
+   * No notify is needed: a `layout` prop change already re-renders the whole
+   * provider subtree, so every GridItem re-reads its snapshot on that pass.
+   */
+  setCommitted(layout: Layout): void;
+  setSession(next: DragSession | null): void;
+  getSession(): DragSession | null;
+  /** Record whether the active drag is keyboard-driven (drives `hidden`). */
+  setKeyboard(value: boolean): void;
+  itemSnapshot: (id: string) => ItemSnapshot;
+  placeholderSnapshot: () => LayoutItem | null;
+  resizeSnapshot: (itemId: string) => ResizeSnapshot;
+  renderedSnapshot: () => Layout;
+  /** A stable index for `id` (see {@link GridController.#indexById}). */
+  itemIndex(id: string): number;
+}
+//#endregion
+//#region src/controller/registry.d.ts
+/** Register a controller under `id` for `manager`. Returns an unregister fn. */
+declare function registerController(manager: object | null | undefined, id: string, controller: GridController): () => void;
+/** The controller registered under `id` for `manager`, or undefined. */
+declare function getController(manager: object | null | undefined, id: string): GridController | undefined;
+//#endregion
+//#region src/dnd/SnapGridEngine.d.ts
+/** Ensure the engine is attached to `manager`; returns a detach (ref-decrement) fn. */
+declare function attachEngine(manager: DragDropManager): () => void;
+//#endregion
+//#region src/dnd/collision.d.ts
+/**
+ * Marker attribute set on every grid container element. Used by {@link gridDepth}
+ * to measure how deeply a grid is nested, purely from the DOM.
+ */
+declare const SNAPGRID_GRID_ATTR = "data-snapgrid-grid";
+/**
+ * Collision detector for grid droppables. Runs dnd-kit's default detector, then —
+ * when nested grid rects overlap (the pointer is over both an inner grid and its
+ * outer one) — ranks the **innermost** grid highest by boosting priority with the
+ * grid's nesting depth. Without this, overlapping grids tie on priority and the
+ * winner is arbitrary. For non-nested grids depth is 0, so priority is unchanged.
+ */
+declare const gridCollisionDetector: CollisionDetector;
+//#endregion
+//#region src/dnd/snapToGrid.d.ts
+interface SnapToGridOptions {
+  /** Current geometry (changes with container width). Read fresh each apply(). */
+  getPositionParams: () => PositionParams;
+  /** Whether snapping is currently enabled (dragConfig.snapToGrid). */
+  isEnabled: () => boolean;
+}
+/**
+ * Quantizes the dragged item's transform to whole grid cells, so the floating
+ * <DragOverlay> clone jumps cell-to-cell in lockstep with the (always-snapped)
+ * placeholder instead of tracking the pointer smoothly. Applied on the item
+ * draggable; a no-op unless `dragConfig.snapToGrid` is set.
+ */
+declare class SnapToGrid extends Modifier<DragDropManager, SnapToGridOptions> {
+  apply({
+    transform
+  }: DragDropManager["dragOperation"]): {
+    x: number;
+    y: number;
+  };
+}
+//#endregion
+//#region src/dnd/entity.d.ts
+/**
+ * The DOM element of a dnd-kit entity (a draggable, droppable, or drag source).
+ * dnd-kit's abstract types don't expose `element`, but the DOM layer snapgrid
+ * runs on always sets it — this centralizes that one assumption (and the cast)
+ * in a single place instead of scattering it across the drag code.
+ */
+declare function domElement(entity: object | null | undefined): Element | null;
+//#endregion
+//#region src/dndShared.d.ts
+/** Marker attribute placed on resize-handle elements. */
+declare const RESIZE_HANDLE_ATTR = "data-snapgrid-resize-handle";
+declare const NO_FEEDBACK: import("@dnd-kit/abstract").PluginDescriptor<any, any, typeof Feedback>[];
+/**
+ * Sensors for item (move) draggables, built from the drag config: a distance
+ * activation threshold (so clicks don't start drags) plus handle/cancel/resize
+ * gating, with the keyboard sensor kept for accessibility.
+ */
+declare function buildItemSensors(threshold: number, getDragConfig: () => DragConfig | undefined): Sensors$1;
+//#endregion
+export { type DragConfig, type DragSourceInfo, type DropConfig, type GridCallbacks, GridController, type GridControllerConfig, type GridDropData, type GridEventCallback, type ItemSnapshot, NO_FEEDBACK, RESIZE_HANDLE_ATTR, type ResizeConfig, type ResizeSnapshot, SNAPGRID_GRID_ATTR, type SnapGridDragData, SnapToGrid, attachEngine, buildItemSensors, domElement, getController, gridCollisionDetector, registerController };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/dnd/dragData.ts","../src/controller/GridController.ts","../src/controller/registry.ts","../src/dnd/SnapGridEngine.ts","../src/dnd/collision.ts","../src/dnd/snapToGrid.ts","../src/dnd/entity.ts","../src/dndShared.ts"],"mappings":";;;;;;;;;;UAMiB,UAAA;EAAA;EAEf,OAAA;;EAEA,OAAA;EAFA;EAIA,MAAA;EAAA;EAEA,MAAA;EAEA;EAAA,SAAA;EAMU;AAAA;AAMZ;;;EANE,UAAA;AAAA;;;;UAMe,YAAA;EAQA;EANf,OAAA;;EAEA,OAAA,GAAU,gBAAgB;AAAA;;UAIX,cAAA;EACf,EAAA;EACA,IAAA;EACA,IAAA;AAAA;;;;;;;;;;UAYe,UAAA;EAMiB;EAJhC,OAAA;EAQ2B;EAN3B,WAAA;IAAgB,CAAA;IAAW,CAAA;EAAA;EAY3B;EAVA,MAAA,IAAU,MAAA,EAAQ,cAAc;AAAA;AAiBlC;AAAA,UAbiB,YAAA;;EAEf,CAAA;EAaS;EAXT,CAAA;EAaa;EAXb,CAAA;AAAA;;;;;KAOU,iBAAA,IACV,MAAA,EAAQ,MAAA,EACR,OAAA,EAAS,UAAA,SACT,OAAA,EAAS,UAAA,SACT,WAAA,EAAa,UAAA,SACb,KAAA,EAAO,KAAA,SACP,IAAA,EAAM,WAAA;;;;;;;;KCzEI,gBAAA;EAGN,IAAA;EAAc,MAAA;EAAgB,IAAA,EAAM,UAAA;EAAY,KAAA;AAAA;EAChD,IAAA;EAAgB,MAAA;EAAgB,MAAA,EAAQ,gBAAgB;EAAE,KAAA;AAAA;;;;;ADLhE;;;UEYiB,aAAA;EACf,WAAA,GAAc,iBAAA;EACd,MAAA,GAAS,iBAAA;EACT,UAAA,GAAa,iBAAA;EACb,aAAA,GAAgB,iBAAA;EAChB,QAAA,GAAW,iBAAA;EACX,YAAA,GAAe,iBAAA;EACf,cAAA,IAAkB,MAAA,EAAQ,MAAA;EAC1B,MAAA,IAAU,MAAA,EAAQ,MAAA,EAAQ,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,KAAA;AAAA;;;;;;;UASpC,oBAAA;EACf,cAAA,EAAgB,cAAA;EAChB,UAAA,EAAY,UAAA;EACZ,KAAA;EACA,QAAA;EACA,WAAA,EAAa,OAAA;EACb,aAAA,EAAe,SAAA;EACf,eAAA,GAAkB,EAAA;EAClB,eAAA,GAAkB,EAAA;EAClB,gBAAA,GAAmB,EAAA,sBAAwB,gBAAA;EAE3C,SAAA,EAAW,SAAA;EACX,UAAA,GAAa,UAAA;EACb,UAAA,GAAa,UAAA;EACb,SAAA,EAAW,aAAA;AAAA;AAAA,UAGI,YAAA;EACf,IAAA,EAAM,UAAU;EAChB,UAAA;EAKA,MAAA;AAAA;AAAA,UAGe,cAAA;EACf,UAAU;AAAA;AFNsB;AAIlC;;;;;;AAJkC,cE0BrB,cAAA;EAAA;EACX,EAAA;EASA,MAAA,EAAQ,oBAAA;EFnBmB;EEwC3B,OAAA,EAAS,eAAA;EFvCD;;;;EE6CR,OAAA,EAAS,OAAA;cAEG,EAAA,UAAY,SAAA,GAAW,MAAA,EAAa,OAAA,GAAU,eAAA;EF1CzC;EEiDjB,YAAA,CAAA,GAAgB,MAAA;EFtDR;EE2DR,SAAA,CAAU,MAAA,EAAQ,oBAAA;EF1DT;;;;;EEmET,KAAA,CAAM,EAAA;EAQN,QAAA;EAEA,SAAA,GAAa,QAAA;EFzEP;;;AAAkB;;;;EEyGxB,YAAA,CAAa,MAAA,EAAQ,MAAA;EAWrB,UAAA,CAAW,IAAA,EAAM,WAAA;EAKjB,UAAA,CAAA,GAAc,WAAA;ED9L8C;ECmM5D,WAAA,CAAY,KAAA;EAMZ,YAAA,GAAgB,EAAA,aAAa,YAAA;EAkB7B,mBAAA,QAA0B,UAAA;EAS1B,cAAA,GAAkB,MAAA,aAAiB,cAAA;EASnC,gBAAA,QAAuB,MAAA;ED7OnB;ECgPJ,SAAA,CAAU,EAAA;AAAA;;;;iBC9NI,kBAAA,CACd,OAAA,6BACA,EAAA,UACA,UAAA,EAAY,cAAc;;iBAUZ,aAAA,CACd,OAAA,6BACA,EAAA,WACC,cAAc;;;;iBCoZD,YAAA,CAAa,OAAwB,EAAf,eAAe;;;;;;;cC1bxC,kBAAA;;;;;ALeD;AAMZ;;cKWa,qBAAA,EAAuB,iBAOnC;;;UC1CgB,iBAAA;;EAEf,iBAAA,QAAyB,cAAc;ENAxB;EMEf,SAAA;AAAA;;;;;;;cASW,UAAA,SAAmB,QAAA,CAAS,eAAA,EAAiB,iBAAA;EAC/C,KAAA,CAAA;IAAQ;EAAA,GAAa,eAAA;;;;;;;;;;;;;iBCZhB,UAAA,CAAW,MAAA,8BAAoC,OAAO;;;;cCIzD,kBAAA;AAAA,cAIA,WAAA,8BAAW,gBAAA,kBAAA,QAAA;;;;;ARQZ;iBQiBI,gBAAA,CACd,SAAA,UACA,aAAA,QAAqB,UAAA,eACpB,SAAO"}

package/dist/index.d.mts

@@ -0,0 +1,261 @@
+import { Compactor, DragSession, GridConfig, Layout, LayoutItem, PositionParams, ResizeHandleAxis } from "@snapgridjs/core";
+import { CollisionDetector } from "@dnd-kit/collision";
+import { Modifier, Modifiers, Sensors } from "@dnd-kit/abstract";
+import { DragDropManager, Feedback, Sensors as Sensors$1 } from "@dnd-kit/dom";
+
+//#region src/types.d.ts
+/**
+ * Drag behaviour configuration (mirrors react-grid-layout v2's `dragConfig`).
+ * The interaction itself is driven by dnd-kit.
+ */
+interface DragConfig {
+  /** Whether items can be dragged. @default true */
+  enabled?: boolean;
+  /** Keep the dragged item within the grid container bounds. @default false */
+  bounded?: boolean;
+  /** CSS selector for a drag handle inside each item. */
+  handle?: string;
+  /** CSS selector for regions that should cancel a drag. */
+  cancel?: string;
+  /** Pixels the pointer must move before a drag starts. @default 3 */
+  threshold?: number;
+  /**
+   * snapgrid extra: snap the dragged tile itself to grid cells while dragging.
+   * When `false` (the default, matching react-grid-layout) the tile follows the
+   * pointer smoothly and only the placeholder snaps.
+   */
+  snapToGrid?: boolean;
+}
+/**
+ * Resize behaviour configuration (mirrors react-grid-layout v2's `resizeConfig`).
+ */
+interface ResizeConfig {
+  /** Whether items can be resized. @default true */
+  enabled?: boolean;
+  /** Which handles to show on each item (item-level `resizeHandles` overrides). @default ['se'] */
+  handles?: ResizeHandleAxis[];
+}
+/** Minimal source shape passed to a {@link DropConfig.accept} predicate. */
+interface DragSourceInfo {
+  id: string | number;
+  type?: unknown;
+  data?: unknown;
+}
+/**
+ * Accept arbitrary (non-grid) dnd-kit draggables dropped into the grid. The
+ * external draggable should carry `data.snapGridDrop = { i?, w?, h? }` to control
+ * the inserted item's id/size; otherwise `defaultItem` is used. On drop the grid
+ * fires `onDrop(layout, item, event)` rather than `onLayoutChange`.
+ *
+ * Requires the grid and the external draggable to share one provider
+ * (e.g. both inside a `<SnapGridGroup>`).
+ */
+interface DropConfig {
+  /** Accept external draggables. @default false */
+  enabled?: boolean;
+  /** Default size for a dropped item when the source omits `snapGridDrop`. @default { w: 1, h: 1 } */
+  defaultItem?: {
+    w: number;
+    h: number;
+  };
+  /** Restrict which external sources are accepted. @default accept any non-grid draggable */
+  accept?: (source: DragSourceInfo) => boolean;
+}
+/** The `data.snapGridDrop` payload an external draggable carries to drop into a grid. */
+interface GridDropData {
+  /** Id for the inserted item (a unique one is generated if omitted). */
+  i?: string;
+  /** Width in grid units. */
+  w?: number;
+  /** Height in grid units. */
+  h?: number;
+}
+/**
+ * react-grid-layout-compatible lifecycle callback.
+ * `(layout, oldItem, newItem, placeholder, event, node)`
+ */
+type GridEventCallback = (layout: Layout, oldItem: LayoutItem | null, newItem: LayoutItem | null, placeholder: LayoutItem | null, event: Event | null, node: HTMLElement | null) => void;
+//#endregion
+//#region src/dnd/dragData.d.ts
+/**
+ * Data attached to the dnd-kit draggables snapgrid creates. `group` is the owning
+ * grid's id, so the centralized {@link SnapGridEngine} can resolve the source
+ * grid's controller from the drag payload (one engine drives every grid).
+ */
+type SnapGridDragData = {
+  kind: "move";
+  itemId: string;
+  item: LayoutItem;
+  group: string;
+} | {
+  kind: "resize";
+  itemId: string;
+  handle: ResizeHandleAxis;
+  group: string;
+};
+//#endregion
+//#region src/controller/GridController.d.ts
+/**
+ * The per-grid drag/resize callbacks the consumer supplied. Published to the
+ * controller so the shared {@link SnapGridEngine} can invoke the RIGHT grid's
+ * callbacks at the right phase (the engine is manager-wide; callbacks are per-grid).
+ */
+interface GridCallbacks {
+  onDragStart?: GridEventCallback;
+  onDrag?: GridEventCallback;
+  onDragStop?: GridEventCallback;
+  onResizeStart?: GridEventCallback;
+  onResize?: GridEventCallback;
+  onResizeStop?: GridEventCallback;
+  onLayoutChange?: (layout: Layout) => void;
+  onDrop?: (layout: Layout, item: LayoutItem, event: Event | null) => void;
+}
+/**
+ * Per-grid configuration the container host writes to the controller each render
+ * (during render, so items that resolve this controller by `group` read fresh
+ * config on the same pass). Also the seam the manager-wide {@link SnapGridEngine}
+ * reads per-grid geometry, compaction, gates, and callbacks from.
+ */
+interface GridControllerConfig {
+  positionParams: PositionParams;
+  gridConfig: GridConfig;
+  width: number;
+  autoSize: boolean;
+  itemSensors: Sensors;
+  itemModifiers: Modifiers;
+  isItemDraggable: (id: string) => boolean;
+  isItemResizable: (id: string) => boolean;
+  resizeHandlesFor: (id: string) => readonly ResizeHandleAxis[];
+  compactor: Compactor;
+  dragConfig?: DragConfig;
+  dropConfig?: DropConfig;
+  callbacks: GridCallbacks;
+}
+interface ItemSnapshot {
+  item: LayoutItem | undefined;
+  isDragging: boolean;
+  hidden: boolean;
+}
+interface ResizeSnapshot {
+  isResizing: boolean;
+}
+/**
+ * Live per-grid drag/resize state as a plain observable: the provider writes
+ * (`setSession`/`setKeyboard`/`setCommitted`), hooks subscribe to just their own
+ * slice via `useSyncExternalStore`. Value-cached snapshots mean a drag re-renders
+ * only the tiles whose slice changed, not the whole subtree (the old
+ * context-value model re-rendered every tile every frame).
+ */
+declare class GridController {
+  #private;
+  id: string;
+  config: GridControllerConfig | null;
+  /** The dnd-kit manager this grid is registered with (set by useInstance). */
+  manager: DragDropManager | undefined;
+  /**
+   * This grid's container element, reported by the host. The engine reads it to
+   * map a pointer to a cell when receiving a tile (its `getBoundingClientRect`).
+   */
+  element: Element | null;
+  constructor(id: string, committed?: Layout, manager?: DragDropManager);
+  /** The committed (base) layout — the engine's source of truth during a drag. */
+  getCommitted(): Layout;
+  /** Replace the per-grid config (called by the container host during render). */
+  setConfig(config: GridControllerConfig): void;
+  /**
+   * Re-point this grid's id. The container host syncs it (during render, before
+   * the droppable/group read it) when the controlled `id` prop changes, so the
+   * returned `group`, the droppable id, and the registry key never drift apart.
+   */
+  setId(id: string): void;
+  register: () => void;
+  subscribe: (listener: () => void) => (() => void);
+  /**
+   * Sync the committed layout from the controlled `layout` prop. Called during
+   * the provider's render, so it must NOT notify — emitting here would update
+   * subscribed GridItems mid-render (a React "setState while rendering" error).
+   * No notify is needed: a `layout` prop change already re-renders the whole
+   * provider subtree, so every GridItem re-reads its snapshot on that pass.
+   */
+  setCommitted(layout: Layout): void;
+  setSession(next: DragSession | null): void;
+  getSession(): DragSession | null;
+  /** Record whether the active drag is keyboard-driven (drives `hidden`). */
+  setKeyboard(value: boolean): void;
+  itemSnapshot: (id: string) => ItemSnapshot;
+  placeholderSnapshot: () => LayoutItem | null;
+  resizeSnapshot: (itemId: string) => ResizeSnapshot;
+  renderedSnapshot: () => Layout;
+  /** A stable index for `id` (see {@link GridController.#indexById}). */
+  itemIndex(id: string): number;
+}
+//#endregion
+//#region src/controller/registry.d.ts
+/** Register a controller under `id` for `manager`. Returns an unregister fn. */
+declare function registerController(manager: object | null | undefined, id: string, controller: GridController): () => void;
+/** The controller registered under `id` for `manager`, or undefined. */
+declare function getController(manager: object | null | undefined, id: string): GridController | undefined;
+//#endregion
+//#region src/dnd/SnapGridEngine.d.ts
+/** Ensure the engine is attached to `manager`; returns a detach (ref-decrement) fn. */
+declare function attachEngine(manager: DragDropManager): () => void;
+//#endregion
+//#region src/dnd/collision.d.ts
+/**
+ * Marker attribute set on every grid container element. Used by {@link gridDepth}
+ * to measure how deeply a grid is nested, purely from the DOM.
+ */
+declare const SNAPGRID_GRID_ATTR = "data-snapgrid-grid";
+/**
+ * Collision detector for grid droppables. Runs dnd-kit's default detector, then —
+ * when nested grid rects overlap (the pointer is over both an inner grid and its
+ * outer one) — ranks the **innermost** grid highest by boosting priority with the
+ * grid's nesting depth. Without this, overlapping grids tie on priority and the
+ * winner is arbitrary. For non-nested grids depth is 0, so priority is unchanged.
+ */
+declare const gridCollisionDetector: CollisionDetector;
+//#endregion
+//#region src/dnd/snapToGrid.d.ts
+interface SnapToGridOptions {
+  /** Current geometry (changes with container width). Read fresh each apply(). */
+  getPositionParams: () => PositionParams;
+  /** Whether snapping is currently enabled (dragConfig.snapToGrid). */
+  isEnabled: () => boolean;
+}
+/**
+ * Quantizes the dragged item's transform to whole grid cells, so the floating
+ * <DragOverlay> clone jumps cell-to-cell in lockstep with the (always-snapped)
+ * placeholder instead of tracking the pointer smoothly. Applied on the item
+ * draggable; a no-op unless `dragConfig.snapToGrid` is set.
+ */
+declare class SnapToGrid extends Modifier<DragDropManager, SnapToGridOptions> {
+  apply({
+    transform
+  }: DragDropManager["dragOperation"]): {
+    x: number;
+    y: number;
+  };
+}
+//#endregion
+//#region src/dnd/entity.d.ts
+/**
+ * The DOM element of a dnd-kit entity (a draggable, droppable, or drag source).
+ * dnd-kit's abstract types don't expose `element`, but the DOM layer snapgrid
+ * runs on always sets it — this centralizes that one assumption (and the cast)
+ * in a single place instead of scattering it across the drag code.
+ */
+declare function domElement(entity: object | null | undefined): Element | null;
+//#endregion
+//#region src/dndShared.d.ts
+/** Marker attribute placed on resize-handle elements. */
+declare const RESIZE_HANDLE_ATTR = "data-snapgrid-resize-handle";
+declare const NO_FEEDBACK: import("@dnd-kit/abstract").PluginDescriptor<any, any, typeof Feedback>[];
+/**
+ * Sensors for item (move) draggables, built from the drag config: a distance
+ * activation threshold (so clicks don't start drags) plus handle/cancel/resize
+ * gating, with the keyboard sensor kept for accessibility.
+ */
+declare function buildItemSensors(threshold: number, getDragConfig: () => DragConfig | undefined): Sensors$1;
+//#endregion
+export { type DragConfig, type DragSourceInfo, type DropConfig, type GridCallbacks, GridController, type GridControllerConfig, type GridDropData, type GridEventCallback, type ItemSnapshot, NO_FEEDBACK, RESIZE_HANDLE_ATTR, type ResizeConfig, type ResizeSnapshot, SNAPGRID_GRID_ATTR, type SnapGridDragData, SnapToGrid, attachEngine, buildItemSensors, domElement, getController, gridCollisionDetector, registerController };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/dnd/dragData.ts","../src/controller/GridController.ts","../src/controller/registry.ts","../src/dnd/SnapGridEngine.ts","../src/dnd/collision.ts","../src/dnd/snapToGrid.ts","../src/dnd/entity.ts","../src/dndShared.ts"],"mappings":";;;;;;;;;;UAMiB,UAAA;EAAA;EAEf,OAAA;;EAEA,OAAA;EAFA;EAIA,MAAA;EAAA;EAEA,MAAA;EAEA;EAAA,SAAA;EAMU;AAAA;AAMZ;;;EANE,UAAA;AAAA;;;;UAMe,YAAA;EAQA;EANf,OAAA;;EAEA,OAAA,GAAU,gBAAgB;AAAA;;UAIX,cAAA;EACf,EAAA;EACA,IAAA;EACA,IAAA;AAAA;;;;;;;;;;UAYe,UAAA;EAMiB;EAJhC,OAAA;EAQ2B;EAN3B,WAAA;IAAgB,CAAA;IAAW,CAAA;EAAA;EAY3B;EAVA,MAAA,IAAU,MAAA,EAAQ,cAAc;AAAA;AAiBlC;AAAA,UAbiB,YAAA;;EAEf,CAAA;EAaS;EAXT,CAAA;EAaa;EAXb,CAAA;AAAA;;;;;KAOU,iBAAA,IACV,MAAA,EAAQ,MAAA,EACR,OAAA,EAAS,UAAA,SACT,OAAA,EAAS,UAAA,SACT,WAAA,EAAa,UAAA,SACb,KAAA,EAAO,KAAA,SACP,IAAA,EAAM,WAAA;;;;;;;;KCzEI,gBAAA;EAGN,IAAA;EAAc,MAAA;EAAgB,IAAA,EAAM,UAAA;EAAY,KAAA;AAAA;EAChD,IAAA;EAAgB,MAAA;EAAgB,MAAA,EAAQ,gBAAgB;EAAE,KAAA;AAAA;;;;;ADLhE;;;UEYiB,aAAA;EACf,WAAA,GAAc,iBAAA;EACd,MAAA,GAAS,iBAAA;EACT,UAAA,GAAa,iBAAA;EACb,aAAA,GAAgB,iBAAA;EAChB,QAAA,GAAW,iBAAA;EACX,YAAA,GAAe,iBAAA;EACf,cAAA,IAAkB,MAAA,EAAQ,MAAA;EAC1B,MAAA,IAAU,MAAA,EAAQ,MAAA,EAAQ,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,KAAA;AAAA;;;;;;;UASpC,oBAAA;EACf,cAAA,EAAgB,cAAA;EAChB,UAAA,EAAY,UAAA;EACZ,KAAA;EACA,QAAA;EACA,WAAA,EAAa,OAAA;EACb,aAAA,EAAe,SAAA;EACf,eAAA,GAAkB,EAAA;EAClB,eAAA,GAAkB,EAAA;EAClB,gBAAA,GAAmB,EAAA,sBAAwB,gBAAA;EAE3C,SAAA,EAAW,SAAA;EACX,UAAA,GAAa,UAAA;EACb,UAAA,GAAa,UAAA;EACb,SAAA,EAAW,aAAA;AAAA;AAAA,UAGI,YAAA;EACf,IAAA,EAAM,UAAU;EAChB,UAAA;EAKA,MAAA;AAAA;AAAA,UAGe,cAAA;EACf,UAAU;AAAA;AFNsB;AAIlC;;;;;;AAJkC,cE0BrB,cAAA;EAAA;EACX,EAAA;EASA,MAAA,EAAQ,oBAAA;EFnBmB;EEwC3B,OAAA,EAAS,eAAA;EFvCD;;;;EE6CR,OAAA,EAAS,OAAA;cAEG,EAAA,UAAY,SAAA,GAAW,MAAA,EAAa,OAAA,GAAU,eAAA;EF1CzC;EEiDjB,YAAA,CAAA,GAAgB,MAAA;EFtDR;EE2DR,SAAA,CAAU,MAAA,EAAQ,oBAAA;EF1DT;;;;;EEmET,KAAA,CAAM,EAAA;EAQN,QAAA;EAEA,SAAA,GAAa,QAAA;EFzEP;;;AAAkB;;;;EEyGxB,YAAA,CAAa,MAAA,EAAQ,MAAA;EAWrB,UAAA,CAAW,IAAA,EAAM,WAAA;EAKjB,UAAA,CAAA,GAAc,WAAA;ED9L8C;ECmM5D,WAAA,CAAY,KAAA;EAMZ,YAAA,GAAgB,EAAA,aAAa,YAAA;EAkB7B,mBAAA,QAA0B,UAAA;EAS1B,cAAA,GAAkB,MAAA,aAAiB,cAAA;EASnC,gBAAA,QAAuB,MAAA;ED7OnB;ECgPJ,SAAA,CAAU,EAAA;AAAA;;;;iBC9NI,kBAAA,CACd,OAAA,6BACA,EAAA,UACA,UAAA,EAAY,cAAc;;iBAUZ,aAAA,CACd,OAAA,6BACA,EAAA,WACC,cAAc;;;;iBCoZD,YAAA,CAAa,OAAwB,EAAf,eAAe;;;;;;;cC1bxC,kBAAA;;;;;ALeD;AAMZ;;cKWa,qBAAA,EAAuB,iBAOnC;;;UC1CgB,iBAAA;;EAEf,iBAAA,QAAyB,cAAc;ENAxB;EMEf,SAAA;AAAA;;;;;;;cASW,UAAA,SAAmB,QAAA,CAAS,eAAA,EAAiB,iBAAA;EAC/C,KAAA,CAAA;IAAQ;EAAA,GAAa,eAAA;;;;;;;;;;;;;iBCZhB,UAAA,CAAW,MAAA,8BAAoC,OAAO;;;;cCIzD,kBAAA;AAAA,cAIA,WAAA,8BAAW,gBAAA,kBAAA,QAAA;;;;;ARQZ;iBQiBI,gBAAA,CACd,SAAA,UACA,aAAA,QAAqB,UAAA,eACpB,SAAO"}