@andrewcyuan/focusgrid 0.1.0

package/dist/core/index.d.cts

@@ -0,0 +1,184 @@
+//#region core/src/layout/types.d.ts
+type PaneId = string;
+type NodeId = string;
+type Orientation = "horizontal" | "vertical";
+declare const cardinalDirections: readonly ["left", "right", "up", "down"];
+type CardinalDirection = (typeof cardinalDirections)[number];
+declare enum PaneCommandCapability {
+  ResizeX = "canResizeX",
+  ResizeY = "canResizeY",
+  Remove = "canRemove",
+  SplitHorizontal = "canSplitHorizontal",
+  SplitVertical = "canSplitVertical",
+  SwapX = "canSwapX",
+  SwapY = "canSwapY",
+  Focus = "canFocus"
+}
+type PaneCommandCapabilityInput = Partial<Record<PaneCommandCapability, boolean>>;
+type PaneNode = {
+  kind: "pane";
+  id: NodeId;
+  paneId: PaneId;
+} & PaneCommandCapabilityInput;
+type SplitNode = {
+  kind: "split";
+  id: NodeId;
+  orientation: Orientation;
+  children: LayoutNode[];
+  sizes: number[];
+  lastFocusedChildId?: NodeId;
+};
+type LayoutNode = PaneNode | SplitNode;
+type Rect = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+type ComputedPane = {
+  paneId: PaneId;
+  nodeId: NodeId;
+  rect: Rect;
+  active: boolean;
+};
+type ComputedHandle = {
+  id: string;
+  splitId: NodeId;
+  index: number;
+  rect: Rect;
+  direction: Orientation;
+};
+type ComputedNode = {
+  kind: "pane";
+  pane: ComputedPane;
+} | {
+  kind: "split";
+  orientation: Orientation;
+  children: ComputedNode[];
+  handles: ComputedHandle[];
+};
+type ComputedLayout = {
+  root: ComputedNode;
+  rectByNodeId: Map<NodeId, Rect>;
+  panes: ComputedPane[];
+  handles: ComputedHandle[];
+};
+type FocusGridControllerState = {
+  root: LayoutNode;
+  activePaneId: PaneId | null;
+  container: {
+    width: number;
+    height: number;
+  };
+};
+//#endregion
+//#region core/src/controller.d.ts
+interface DomController {
+  focus(paneId: PaneId): boolean;
+}
+type Listener = (next: FocusGridControllerState, previous: FocusGridControllerState) => void;
+type PaneLayoutChangeEvent = {
+  pane: ComputedPane;
+  previousPane: ComputedPane;
+  controller: FocusGridController;
+};
+type PaneCloseEvent = {
+  paneId: PaneId;
+  previousPane: ComputedPane;
+  controller: FocusGridController;
+};
+type PaneEventHandlers = {
+  onPaneLayoutChange?: (event: PaneLayoutChangeEvent) => void;
+  onPaneClose?: (event: PaneCloseEvent) => void;
+};
+type PaneDefaults = PaneCommandCapabilityInput;
+type FocusGridControllerProps = FocusGridControllerState & {
+  paneDefaults?: PaneDefaults;
+  minWidth?: number;
+  minHeight?: number;
+  directionalFocusOverflow?: boolean;
+};
+type SplitPaneOptions = Partial<Omit<PaneNode, "kind" | "id" | "paneId">> & {
+  side: CardinalDirection;
+  newPaneId?: PaneId;
+  newPaneNodeId?: NodeId;
+  splitId?: NodeId;
+  preserveActivePane?: boolean;
+};
+type ResizePaneOptions = {
+  direction: CardinalDirection;
+  deltaPx: number;
+};
+type ResizeHandleOptions = {
+  index: number;
+  deltaPx: number;
+  snapshotSizes?: number[];
+};
+declare class FocusGridController {
+  private readonly domController;
+  readonly minWidth: number;
+  readonly minHeight: number;
+  readonly directionalFocusOverflow: boolean;
+  private currentState;
+  private cachedLayout;
+  private readonly paneDefaults;
+  private readonly listeners;
+  constructor({
+    paneDefaults,
+    minWidth,
+    minHeight,
+    directionalFocusOverflow,
+    ...state
+  }: FocusGridControllerProps, domController: DomController);
+  /** Computed render data; stable until the next committed change. */
+  getLayout(): ComputedLayout;
+  getPane(paneId: PaneId): PaneNode | null;
+  getContainerSize(): {
+    width: number;
+    height: number;
+  };
+  getSplitSizes(splitId: NodeId): number[] | null;
+  splitActive(side: CardinalDirection): PaneId | null;
+  removeActive(): boolean;
+  focusAdjacent(direction: CardinalDirection): boolean;
+  swapAdjacent(direction: CardinalDirection): boolean;
+  resizeActive(direction: CardinalDirection, deltaPx: number): boolean;
+  split(paneNodeId: NodeId, props: SplitPaneOptions): PaneId | null;
+  remove(paneId: PaneId): boolean;
+  swap(firstPaneId: PaneId, secondPaneId: PaneId): boolean;
+  resize(paneId: PaneId, props: ResizePaneOptions): boolean;
+  resizeHandle(splitId: NodeId, props: ResizeHandleOptions): boolean;
+  focus(paneId: PaneId): boolean;
+  updatePane(paneId: PaneId, patch: Partial<Omit<PaneNode, "kind" | "id" | "paneId">>): boolean;
+  setContainerSize(width: number, height: number): boolean;
+  private commit;
+  subscribePaneEvents({
+    onPaneLayoutChange,
+    onPaneClose
+  }: PaneEventHandlers): () => void;
+  subscribe(listener: Listener): () => void;
+}
+//#endregion
+//#region core/src/validation.d.ts
+type FocusGridStateValidationError = {
+  code: string;
+  path: string;
+  message: string;
+  paneId?: PaneId;
+  nodeId?: NodeId;
+};
+type FocusGridStateValidationResult = {
+  ok: true;
+  state: FocusGridControllerState;
+  errors: [];
+} | {
+  ok: false;
+  errors: FocusGridStateValidationError[];
+};
+declare class FocusGridStateValidationException extends Error {
+  readonly errors: FocusGridStateValidationError[];
+  constructor(errors: FocusGridStateValidationError[]);
+}
+declare function validateFocusGridControllerState(input: unknown): FocusGridStateValidationResult;
+//#endregion
+export { type CardinalDirection, type ComputedHandle, type ComputedLayout, type ComputedNode, type ComputedPane, type DomController, FocusGridController, type FocusGridControllerProps, type FocusGridControllerState, type FocusGridStateValidationError, FocusGridStateValidationException, type FocusGridStateValidationResult, type LayoutNode, type Listener, type NodeId, type PaneCloseEvent, PaneCommandCapability, type PaneCommandCapabilityInput, type PaneDefaults, type PaneEventHandlers, type PaneId, type PaneLayoutChangeEvent, type PaneNode, type Rect, type ResizeHandleOptions, type ResizePaneOptions, type SplitNode, type SplitPaneOptions, cardinalDirections, validateFocusGridControllerState };

package/dist/core/index.d.ts

@@ -0,0 +1,184 @@
+//#region core/src/layout/types.d.ts
+type PaneId = string;
+type NodeId = string;
+type Orientation = "horizontal" | "vertical";
+declare const cardinalDirections: readonly ["left", "right", "up", "down"];
+type CardinalDirection = (typeof cardinalDirections)[number];
+declare enum PaneCommandCapability {
+  ResizeX = "canResizeX",
+  ResizeY = "canResizeY",
+  Remove = "canRemove",
+  SplitHorizontal = "canSplitHorizontal",
+  SplitVertical = "canSplitVertical",
+  SwapX = "canSwapX",
+  SwapY = "canSwapY",
+  Focus = "canFocus"
+}
+type PaneCommandCapabilityInput = Partial<Record<PaneCommandCapability, boolean>>;
+type PaneNode = {
+  kind: "pane";
+  id: NodeId;
+  paneId: PaneId;
+} & PaneCommandCapabilityInput;
+type SplitNode = {
+  kind: "split";
+  id: NodeId;
+  orientation: Orientation;
+  children: LayoutNode[];
+  sizes: number[];
+  lastFocusedChildId?: NodeId;
+};
+type LayoutNode = PaneNode | SplitNode;
+type Rect = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+type ComputedPane = {
+  paneId: PaneId;
+  nodeId: NodeId;
+  rect: Rect;
+  active: boolean;
+};
+type ComputedHandle = {
+  id: string;
+  splitId: NodeId;
+  index: number;
+  rect: Rect;
+  direction: Orientation;
+};
+type ComputedNode = {
+  kind: "pane";
+  pane: ComputedPane;
+} | {
+  kind: "split";
+  orientation: Orientation;
+  children: ComputedNode[];
+  handles: ComputedHandle[];
+};
+type ComputedLayout = {
+  root: ComputedNode;
+  rectByNodeId: Map<NodeId, Rect>;
+  panes: ComputedPane[];
+  handles: ComputedHandle[];
+};
+type FocusGridControllerState = {
+  root: LayoutNode;
+  activePaneId: PaneId | null;
+  container: {
+    width: number;
+    height: number;
+  };
+};
+//#endregion
+//#region core/src/controller.d.ts
+interface DomController {
+  focus(paneId: PaneId): boolean;
+}
+type Listener = (next: FocusGridControllerState, previous: FocusGridControllerState) => void;
+type PaneLayoutChangeEvent = {
+  pane: ComputedPane;
+  previousPane: ComputedPane;
+  controller: FocusGridController;
+};
+type PaneCloseEvent = {
+  paneId: PaneId;
+  previousPane: ComputedPane;
+  controller: FocusGridController;
+};
+type PaneEventHandlers = {
+  onPaneLayoutChange?: (event: PaneLayoutChangeEvent) => void;
+  onPaneClose?: (event: PaneCloseEvent) => void;
+};
+type PaneDefaults = PaneCommandCapabilityInput;
+type FocusGridControllerProps = FocusGridControllerState & {
+  paneDefaults?: PaneDefaults;
+  minWidth?: number;
+  minHeight?: number;
+  directionalFocusOverflow?: boolean;
+};
+type SplitPaneOptions = Partial<Omit<PaneNode, "kind" | "id" | "paneId">> & {
+  side: CardinalDirection;
+  newPaneId?: PaneId;
+  newPaneNodeId?: NodeId;
+  splitId?: NodeId;
+  preserveActivePane?: boolean;
+};
+type ResizePaneOptions = {
+  direction: CardinalDirection;
+  deltaPx: number;
+};
+type ResizeHandleOptions = {
+  index: number;
+  deltaPx: number;
+  snapshotSizes?: number[];
+};
+declare class FocusGridController {
+  private readonly domController;
+  readonly minWidth: number;
+  readonly minHeight: number;
+  readonly directionalFocusOverflow: boolean;
+  private currentState;
+  private cachedLayout;
+  private readonly paneDefaults;
+  private readonly listeners;
+  constructor({
+    paneDefaults,
+    minWidth,
+    minHeight,
+    directionalFocusOverflow,
+    ...state
+  }: FocusGridControllerProps, domController: DomController);
+  /** Computed render data; stable until the next committed change. */
+  getLayout(): ComputedLayout;
+  getPane(paneId: PaneId): PaneNode | null;
+  getContainerSize(): {
+    width: number;
+    height: number;
+  };
+  getSplitSizes(splitId: NodeId): number[] | null;
+  splitActive(side: CardinalDirection): PaneId | null;
+  removeActive(): boolean;
+  focusAdjacent(direction: CardinalDirection): boolean;
+  swapAdjacent(direction: CardinalDirection): boolean;
+  resizeActive(direction: CardinalDirection, deltaPx: number): boolean;
+  split(paneNodeId: NodeId, props: SplitPaneOptions): PaneId | null;
+  remove(paneId: PaneId): boolean;
+  swap(firstPaneId: PaneId, secondPaneId: PaneId): boolean;
+  resize(paneId: PaneId, props: ResizePaneOptions): boolean;
+  resizeHandle(splitId: NodeId, props: ResizeHandleOptions): boolean;
+  focus(paneId: PaneId): boolean;
+  updatePane(paneId: PaneId, patch: Partial<Omit<PaneNode, "kind" | "id" | "paneId">>): boolean;
+  setContainerSize(width: number, height: number): boolean;
+  private commit;
+  subscribePaneEvents({
+    onPaneLayoutChange,
+    onPaneClose
+  }: PaneEventHandlers): () => void;
+  subscribe(listener: Listener): () => void;
+}
+//#endregion
+//#region core/src/validation.d.ts
+type FocusGridStateValidationError = {
+  code: string;
+  path: string;
+  message: string;
+  paneId?: PaneId;
+  nodeId?: NodeId;
+};
+type FocusGridStateValidationResult = {
+  ok: true;
+  state: FocusGridControllerState;
+  errors: [];
+} | {
+  ok: false;
+  errors: FocusGridStateValidationError[];
+};
+declare class FocusGridStateValidationException extends Error {
+  readonly errors: FocusGridStateValidationError[];
+  constructor(errors: FocusGridStateValidationError[]);
+}
+declare function validateFocusGridControllerState(input: unknown): FocusGridStateValidationResult;
+//#endregion
+export { type CardinalDirection, type ComputedHandle, type ComputedLayout, type ComputedNode, type ComputedPane, type DomController, FocusGridController, type FocusGridControllerProps, type FocusGridControllerState, type FocusGridStateValidationError, FocusGridStateValidationException, type FocusGridStateValidationResult, type LayoutNode, type Listener, type NodeId, type PaneCloseEvent, PaneCommandCapability, type PaneCommandCapabilityInput, type PaneDefaults, type PaneEventHandlers, type PaneId, type PaneLayoutChangeEvent, type PaneNode, type Rect, type ResizeHandleOptions, type ResizePaneOptions, type SplitNode, type SplitPaneOptions, cardinalDirections, validateFocusGridControllerState };