Rename FocusNode interface

Author: vovacodes

packages/demo/src/apps/ConsoleUI/index.tsx

@@ -2,7 +2,7 @@ import * as React from "react"
 import { useCallback } from "react"
 import { useHistory } from "react-router-dom"
 
-import { defaultGetPreferredChildOnFocus, Direction, FIXMEFocusableNode, Focusable, FocusEvent } from "react-sunbeam"
+import { defaultGetPreferredChildOnFocus, Direction, IFocusableNode, Focusable, FocusEvent } from "react-sunbeam"
 
 import { ProfilesMenu } from "./ProfilesMenu"
 import { GamesGallery } from "./GamesGallery"
@@ -51,8 +51,8 @@ export function ConsoleUI() {
                         focusOrigin,
                         direction,
                     }: {
-                        focusableChildren: Map<string, FIXMEFocusableNode>
-                        focusOrigin?: FIXMEFocusableNode
+                        focusableChildren: Map<string, IFocusableNode>
+                        focusOrigin?: IFocusableNode
                         direction?: Direction
                     }) => {
                         if (!focusOrigin || !direction) {

packages/react-sunbeam/README.md

@@ -183,7 +183,7 @@ render(
 ### `<Root>`
 
 `Root` is the root focusable component.
-It instantiates the focusable tree and holds its root node, as well as passing some utilities through the React context to other focusable components in the tree.
+It instantiates the focusable tree and holds its root node, as well as passing some utilities through React context to other focusable components in the tree.
 
 ```ts
 function Root(props: {
@@ -217,15 +217,15 @@ function useFocusable(params: {
 ```
 
 It can be used both for creating a leaf node or a branch node.
-If the latter is the goal, the node has to be passed down the tree through the React context.
+If the latter is the goal, the node has to be passed down the tree through React context.
 In order to do that, the user needs to render a Branch component and pass it the opaque `node` object returned from the `useFocusable()` call:
 
 ```ts
 const { focused, node } = useFocusable(...)
 
 return (
     <Branch node={node}>
-        ...
+        {/*...*/}
     </Branch>
 )
 ```

packages/react-sunbeam/package.json

@@ -10,12 +10,9 @@
     ],
     "main": "./dist/cjs/index.js",
     "exports": {
-        ".": "./dist/es/index.js",
-        "./keyPressManagement": "./dist/es/keyPressManagement/index.js",
-        "./spatialNavigation": "./dist/es/spatialNavigation/index.js"
+        ".": "./dist/es/index.js"
     },
     "module": "./dist/es/index.js",
-    "unpkg": "./dist/es/index.js",
     "types": "./dist/es/index.d.ts",
     "repository": {
         "type": "git",

packages/react-sunbeam/src/focus/FocusManager.ts

@@ -1,4 +1,4 @@
-import type { FocusPath, FocusUpdatesSubscriber, FIXMEFocusableNode, UnsubscribeFromFocusUpdatesFn } from "./types.js"
+import type { FocusPath, FocusUpdatesSubscriber, IFocusableNode, UnsubscribeFromFocusUpdatesFn } from "./types.js"
 import { getNodeByPath, getPathToNode, getSiblings, validateAndFixFocusPathIfNeeded } from "./FocusableTreeUtils.js"
 import { Direction, getBestCandidate } from "../spatialNavigation/index.js"
 import { boxesWithinFrustumOfOrigin } from "../spatialNavigation/frustumFilteringUtils.js"
@@ -17,7 +17,7 @@ export class FocusManager {
      * path from the focusableRoot to the focusTarget.
      */
     private focusPath: readonly string[]
-    private focusableRoot: FIXMEFocusableNode | undefined
+    private focusableRoot: IFocusableNode | undefined
     private subscribers: Set<FocusUpdatesSubscriber>
 
     public constructor(options: Options = defaultOptions) {
@@ -68,7 +68,7 @@ export class FocusManager {
     // ===================================
 
     /** @private */
-    public setFocusableRoot(focusableRoot: FIXMEFocusableNode): void {
+    public setFocusableRoot(focusableRoot: IFocusableNode): void {
         this.focusableRoot = focusableRoot
 
         this.revalidateFocusPath()
@@ -129,10 +129,10 @@ export class FocusManager {
 }
 
 function findBestCandidateAmongSiblingsOf(
-    treeNode: FIXMEFocusableNode,
-    focusOrigin: FIXMEFocusableNode,
+    treeNode: IFocusableNode,
+    focusOrigin: IFocusableNode,
     direction: Direction
-): FIXMEFocusableNode | null {
+): IFocusableNode | null {
     // Focus doesn't move
     if (isDirectionLocked(direction, treeNode.getLock())) return null
 

packages/react-sunbeam/src/focus/FocusableNode.ts

@@ -1,11 +1,11 @@
 import type { BoundingBox, Direction } from "../spatialNavigation/index.js"
-import type { CustomGetPreferredChildFn, FocusKey, FIXMEFocusableNode } from "./types.js"
+import type { CustomGetPreferredChildFn, FocusKey, IFocusableNode } from "./types.js"
 import { assert } from "../shared/assert.js"
 import getPreferredNode from "./getPreferredNode.js"
 
 export type FocusableNodesMap = Map<FocusKey, FocusableNode>
 
-export class FocusableNode implements FIXMEFocusableNode {
+export class FocusableNode implements IFocusableNode {
     private readonly revalidateFocusPath: () => void
     private readonly focusKey: FocusKey
     private readonly path: FocusKey[]
@@ -72,7 +72,7 @@ export class FocusableNode implements FIXMEFocusableNode {
         this.lock = lock
     }
 
-    public getPreferredChild(focusOrigin?: FIXMEFocusableNode, direction?: Direction) {
+    public getPreferredChild(focusOrigin?: IFocusableNode, direction?: Direction) {
         return this.customGetPreferredChild
             ? this.customGetPreferredChild({
                   focusableChildren: this.children,

packages/react-sunbeam/src/focus/FocusableTreeUtils.ts

@@ -1,7 +1,7 @@
-import type { FocusPath, FIXMEFocusableNode } from "./types.js"
+import type { FocusPath, IFocusableNode } from "./types.js"
 import { FOCUSABLE_TREE_ROOT_KEY } from "./Constants.js"
 
-export function validateAndFixFocusPathIfNeeded(focusPath: FocusPath, treeRoot: FIXMEFocusableNode): FocusPath | null {
+export function validateAndFixFocusPathIfNeeded(focusPath: FocusPath, treeRoot: IFocusableNode): FocusPath | null {
     let fixedFocusPath: string[] | null = null // only initialize if we need to fix the path
     let currentNode = treeRoot
     let focusPathSegmentIndex = 0
@@ -45,18 +45,18 @@ export function validateAndFixFocusPathIfNeeded(focusPath: FocusPath, treeRoot:
     return fixedFocusPath ? fixedFocusPath : null
 }
 
-export function getNodeByPath(path: FocusPath, treeRoot: FIXMEFocusableNode): FIXMEFocusableNode | undefined {
-    return path.reduce((node: FIXMEFocusableNode | undefined, focusKey: string) => {
+export function getNodeByPath(path: FocusPath, treeRoot: IFocusableNode): IFocusableNode | undefined {
+    return path.reduce((node: IFocusableNode | undefined, focusKey: string) => {
         if (node === undefined) return undefined
 
         return node.getChildren().get(focusKey)
     }, treeRoot)
 }
 
-export function getPathToNode(treeNode: FIXMEFocusableNode): FocusPath {
+export function getPathToNode(treeNode: IFocusableNode): FocusPath {
     const path: string[] = []
 
-    let currentNode: FIXMEFocusableNode | undefined = treeNode
+    let currentNode: IFocusableNode | undefined = treeNode
     while (currentNode) {
         const focusKey = currentNode.getFocusKey()
 
@@ -71,9 +71,9 @@ export function getPathToNode(treeNode: FIXMEFocusableNode): FocusPath {
     return path
 }
 
-export function getSiblings(focusableTreeNode: FIXMEFocusableNode): readonly FIXMEFocusableNode[] {
+export function getSiblings(focusableTreeNode: IFocusableNode): readonly IFocusableNode[] {
     const parent = focusableTreeNode.getParent()
-    const siblings: FIXMEFocusableNode[] = []
+    const siblings: IFocusableNode[] = []
 
     if (!parent) return siblings
 

packages/react-sunbeam/src/focus/getClosestFocusableNodeInDirection.ts

@@ -1,9 +1,9 @@
-import type { FIXMEFocusableNode } from "./types.js"
+import type { IFocusableNode } from "./types.js"
 import type { FocusKey } from "./types.js"
 import type { Direction, BoundingBox } from "../spatialNavigation/index.js"
 import { getBestCandidate } from "../spatialNavigation/index.js"
 
-export function getClosestFocusableNodeInDirection<N extends FIXMEFocusableNode>(
+export function getClosestFocusableNodeInDirection<N extends IFocusableNode>(
     focusableNodes: Map<FocusKey, N>,
     focusOrigin: BoundingBox,
     direction: Direction

packages/react-sunbeam/src/focus/getPreferredNode.ts

@@ -1,14 +1,14 @@
-import type { FocusKey, FIXMEFocusableNode } from "./types.js"
+import type { FocusKey, IFocusableNode } from "./types.js"
 import type { Direction } from "../spatialNavigation/index.js"
 import { getClosestFocusableNodeInDirection } from "./getClosestFocusableNodeInDirection.js"
 
 interface Arguments {
-    nodes: Map<FocusKey, FIXMEFocusableNode>
-    focusOrigin?: FIXMEFocusableNode
+    nodes: Map<FocusKey, IFocusableNode>
+    focusOrigin?: IFocusableNode
     direction?: Direction
 }
 
-export default function getPreferredNode({ nodes, focusOrigin, direction }: Arguments): FIXMEFocusableNode | undefined {
+export default function getPreferredNode({ nodes, focusOrigin, direction }: Arguments): IFocusableNode | undefined {
     if (!focusOrigin || !direction) {
         // pick the child that was mounted first
         return nodes.values().next().value

packages/react-sunbeam/src/focus/index.ts

@@ -1,8 +1,8 @@
 import getPreferredNode from "./getPreferredNode.js"
-import type { FIXMEFocusableNode } from "./types.js"
+import type { IFocusableNode } from "./types.js"
 import type { Direction } from "../spatialNavigation/index.js"
 
-export type { FocusEvent, FIXMEFocusableNode } from "./types.js"
+export type { FocusEvent, IFocusableNode } from "./types.js"
 export { FocusManager } from "./FocusManager.js"
 export { Branch } from "./components/Branch.js"
 export { Root } from "./components/Root/index.js"
@@ -15,8 +15,8 @@ export function defaultGetPreferredChildOnFocus({
     focusOrigin,
     direction,
 }: {
-    focusableChildren: Map<string, FIXMEFocusableNode>
-    focusOrigin?: FIXMEFocusableNode
+    focusableChildren: Map<string, IFocusableNode>
+    focusOrigin?: IFocusableNode
     direction?: Direction
 }) {
     return getPreferredNode({ nodes: focusableChildren, focusOrigin, direction })

packages/react-sunbeam/src/focus/types.ts

@@ -14,25 +14,22 @@ export type FocusUpdatesSubscriber = (event: { focusPath: FocusPath }) => void
 export type UnsubscribeFromFocusUpdatesFn = () => void
 
 export type CustomGetPreferredChildFn = (params: {
-    focusableChildren: Map<FocusKey, FIXMEFocusableNode>
-    focusOrigin?: FIXMEFocusableNode
+    focusableChildren: Map<FocusKey, IFocusableNode>
+    focusOrigin?: IFocusableNode
     direction?: Direction
-}) => FIXMEFocusableNode | undefined
+}) => IFocusableNode | undefined
 
-export type GetPreferredChildFn = (
-    focusOrigin?: FIXMEFocusableNode,
-    direction?: Direction
-) => FIXMEFocusableNode | undefined
+export type GetPreferredChildFn = (focusOrigin?: IFocusableNode, direction?: Direction) => IFocusableNode | undefined
 
 /**
  * The public API version of FocusableNode class's interface.
  */
-export interface FIXMEFocusableNode {
+export interface IFocusableNode {
     getFocusKey(): FocusKey
     getPath(): FocusKey[]
     getBoundingBox(): BoundingBox
-    getParent(): FIXMEFocusableNode | undefined
-    getChildren(): Map<FocusKey, FIXMEFocusableNode>
+    getParent(): IFocusableNode | undefined
+    getChildren(): Map<FocusKey, IFocusableNode>
     getPreferredChild: GetPreferredChildFn
     getLock(): Direction[] | Direction | undefined
 }