react-component-instance 0.0.11 → 0.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-component-instance",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "Get a React class component instance from its DOM Element",
   "keywords": [
     "react",
@@ -35,15 +35,15 @@
     "@babel/eslint-parser": "^7.26.10",
     "@babel/preset-env": "^7.26.9",
     "@babel/preset-react": "^7.26.3",
-    "@sequencemedia/eslint-config-standard": "^0.2.43",
-    "@sequencemedia/eslint-config-typescript": "^0.1.63",
+    "@sequencemedia/eslint-config-standard": "^0.2.44",
+    "@sequencemedia/eslint-config-typescript": "^0.1.64",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.2.0",
     "@types/debug": "^4.1.12",
     "@types/jest": "^29.5.14",
     "@types/react": "^19.0.12",
     "core-js": "^3.41.0",
-    "eslint": "^9.22.0",
+    "eslint": "^9.23.0",
     "eslint-plugin-react": "^7.37.4",
     "globals": "^16.0.0",
     "husky": "^9.1.7",

package/src/index.d.mts

@@ -0,0 +1,27 @@
+import type React from 'react'
+import type {
+  RenderResult as RenderType
+} from '@testing-library/react'
+
+type FiberRootNode = ReactComponentInstanceTypes.FiberRootNode
+type FiberNode = ReactComponentInstanceTypes.FiberNode
+
+export function getContainerFiberNodeFrom (containerElement?: Element | null): FiberRootNode | null | undefined
+
+export function getFiberNodeFrom (element?: Element | null): FiberNode | null | undefined
+
+export function getParentFiberNodeFrom (element?: Element | null): FiberNode | null | undefined
+
+export function getChildFiberNodeFrom (element?: Element | null): FiberNode | null | undefined
+
+export function getComponentElementFromRender (render: RenderType): Element | null
+
+export function getContainerElementFromRender (render: RenderType): Element | null
+
+export function getInstanceFromContainerElement (containerElement?: Element | null): React.Component<any, any> | HTMLElement | Text | null
+
+export function getInstanceFromComponentElement (componentElement?: Element | null): React.Component<any, any> | HTMLElement | Text | null
+
+export function findInstanceFor (element: Element | null | undefined, Component: (() => React.JSX.Element) | typeof React.Component) : React.Component<any, any> | HTMLElement | Text | null
+
+export function getInstance (render: RenderType): React.Component<any, any> | HTMLElement | Text | null

package/src/index.mjs

@@ -16,7 +16,7 @@ import {
 } from './utils/index.mjs'
 
 /**
- *  @param {Element | null | undefined} containerElement
+ *  @param {Element | null} [containerElement]
  *  @returns {FiberRootNode | null | undefined}
  */
 export function getContainerFiberNodeFrom (containerElement) {

package/src/utils/index.d.mts

@@ -0,0 +1,38 @@
+import type React from 'react'
+
+type FiberRootNode = ReactComponentInstanceTypes.FiberRootNode
+type FiberNode = ReactComponentInstanceTypes.FiberNode
+
+export function isReactFiberKey (key: PropertyKey) : boolean
+
+export function isReactPropsKey (key: PropertyKey) : boolean
+
+export function isReactContainerFiberKey (key: PropertyKey): boolean
+
+export function getReactFiberKey (element: Element): string | undefined
+
+export function getReactPropsKey (element: Element): string | undefined
+
+export function getReactContainerFiberKey (element: Element): string | undefined
+
+export function getFiberFrom (element: Element): FiberNode | null | undefined
+
+export function getParentFiberFrom (element: Element): FiberNode | null | undefined
+
+export function getChildFiberFrom (element: Element): FiberNode | null | undefined
+
+export function getContainerFiberFrom (element: Element): FiberNode | null | undefined
+
+export function getParentFiber (fiber: FiberNode): FiberNode | null | undefined
+
+export function getChildFiber (fiber: FiberNode): FiberNode | null | undefined
+
+export function getComponentInstance (fiber: FiberNode): React.Component<any, any> | HTMLElement | Text | null
+
+export function getContainerInstance (fiber: FiberRootNode): React.Component<any, any> | HTMLElement | Text | null
+
+export function isComponentType (Component: (() => React.JSX.Element) | typeof React.Component, fiber: FiberNode): boolean
+
+export function getIsComponentType (Component: (() => React.JSX.Element) | typeof React.Component): (fiber: FiberNode) => boolean
+
+export function traverseFiberParents (fiber: FiberNode): Generator<FiberNode | null | undefined, null, unknown>