context-menu machine

interface ContextMenuActionable {
  readonly id: string;
  readonly disabled?: boolean;
  readonly textValue?: string;
}

type ContextMenuChangeReason = ContextMenuOpenReason | ContextMenuCloseReason;

type ContextMenuCloseReason = "escape" | "outside-click" | "select" | "programmatic";

type ContextMenuCommand = (CommandObject & {
  readonly type: "OPEN_CHANGE_REQUEST";
  readonly open: boolean;
  readonly reason: ContextMenuChangeReason;
}) | (CommandObject & {
  readonly type: "SELECT_ITEM";
  readonly id: string;
}) | ScheduleCommand<ContextMenuEvent> | CancelCommand;

type ContextMenuContext = {
  readonly mode: "controlled" | "uncontrolled";
  readonly position: ContextMenuPosition | null;
  /** Original item index. Divider gaps are retained. */
  readonly highlightedIndex: number;
  readonly typeaheadBuffer: string;
};

export declare const ContextMenuDiagnosticCodes: readonly DiagnosticCatalogueEntry[];

interface ContextMenuDivider {
  readonly divider: true;
}

type ContextMenuEvent = {
  readonly type: "OPEN_AT";
  readonly position: ContextMenuPosition;
  readonly reason: ContextMenuOpenReason;
} | {
  readonly type: "OPEN";
  readonly reason: "programmatic";
} | {
  readonly type: "CLOSE";
  readonly reason: ContextMenuCloseReason;
} | {
  readonly type: "MOVE";
  readonly direction: -1 | 1;
} | {
  readonly type: "HIGHLIGHT";
  readonly index: number;
} | {
  readonly type: "SELECT";
} | {
  readonly type: "TYPEAHEAD";
  readonly char: string;
};

type ContextMenuInput = {
  /** Controlled open state. Defining it fixes controlled mode at first start. */
  readonly open?: boolean;
  /** Uncontrolled initial open state. */
  readonly defaultOpen?: boolean;
  /** Position used by defaultOpen or programmatic OPEN when no pointer exists. */
  readonly defaultPosition?: ContextMenuPosition;
  /** The original entry list, including divider rows. */
  readonly items: readonly ContextMenuItem[];
  readonly typeaheadTimeoutMs?: number;
};

type ContextMenuItem = ContextMenuActionable | ContextMenuDivider;

export declare const contextMenuMachine: ContextMenuMachine;

type ContextMenuMachine = Machine<ContextMenuInput, ContextMenuStateValue, ContextMenuContext, ContextMenuEvent, ContextMenuCommand>;

type ContextMenuOpenReason = "pointer" | "programmatic";

type ContextMenuPosition = {
  readonly x: number;
  readonly y: number;
};

export declare const contextMenuReplaySequence: readonly ContextMenuEvent[];

export declare const contextMenuSelectors: {
  open: (snapshot: ContextMenuSnapshot) => boolean;
  position: (snapshot: ContextMenuSnapshot) => ContextMenuPosition | null;
  highlightedIndex: (snapshot: ContextMenuSnapshot) => number;
  typeaheadBuffer: (snapshot: ContextMenuSnapshot) => string;
};

type ContextMenuSnapshot = Snapshot<ContextMenuStateValue, ContextMenuContext>;

type ContextMenuStateValue = "open" | "closed";