react-component-snapshot 0.0.7 → 0.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-component-snapshot",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Transform a React component to match its snapshot in Jest",
   "keywords": [
     "react",
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "debug": "^4.4.0",
-    "react-component-name": "^0.0.3"
+    "react-component-name": "^0.0.4"
   },
   "devDependencies": {
     "@babel/core": "^7.26.10",

package/src/fiber/index.d.mts

@@ -0,0 +1,12 @@
+import type React from 'react'
+
+type FiberNode = ReactComponentSnapshotTypes.FiberNode
+type StateNodeType = Element | Text | React.Component<any, any>
+
+export function getStateNodeFiber (stateNode: StateNodeType) : Record<PropertyKey, unknown> | null
+
+export function getStateNodeProps (stateNode: StateNodeType): Record<PropertyKey, unknown> | null
+
+export function getFiber (element: Element): FiberNode | null
+
+export default function getSnapshot (fiberNode: FiberNode): Record<PropertyKey, unknown>

package/src/fiber/index.mjs

@@ -8,7 +8,8 @@ import {
 } from 'react-component-name'
 
 import {
-  REACT_COMPONENT_SNAPSHOT
+  REACT_COMPONENT_FORWARD_REF_TYPE,
+  REACT_COMPONENT_SNAPSHOT_TYPE
 } from './symbols.mjs'
 
 /**
@@ -16,7 +17,7 @@ import {
  *  @returns {v is object}
  */
 function isObject (v) {
-  return (v || false) instanceof Object && !Array.isArray(v)
+  return typeof (v || false) === 'object' && !Array.isArray(v)
 }
 
 /**
@@ -144,8 +145,14 @@ function getProps (fiberNode) {
       Object.fromEntries(
         Object.entries(props)
           .filter(([key]) => key !== 'children')
-          .filter(([key, value]) => {
-            if (isObject(value)) return !('current' in value)
+          .filter(([key]) => key !== 'ref')
+          .filter(([key, value]) => { // key is not `ref` but value may be a `ref`
+            if (isObject(value)) {
+              return !(
+                value.$$typeof !== REACT_COMPONENT_FORWARD_REF_TYPE /* forward ref */ ||
+                'current' in value /* ref shape */
+              )
+            }
             return true
           })
       )
@@ -233,7 +240,7 @@ export default function getSnapshot (fiberNode) {
       children
     },
     '$$typeof', {
-      value: REACT_COMPONENT_SNAPSHOT
+      value: REACT_COMPONENT_SNAPSHOT_TYPE
     })
   )
 }

package/src/fiber/symbols.mjs

@@ -1 +1,3 @@
-export const REACT_COMPONENT_SNAPSHOT = Symbol.for('react.test.json')
+export const REACT_COMPONENT_FORWARD_REF_TYPE = Symbol.for('react.forward_ref')
+
+export const REACT_COMPONENT_SNAPSHOT_TYPE = Symbol.for('react.test.json')

package/src/index.d.mts

@@ -0,0 +1,21 @@
+import type {
+  RenderResult as RenderType
+} from '@testing-library/react'
+
+export function getComponentElement (render: RenderType): Element | null
+
+export function getComponentElementFromRender (render: RenderType): Element | null
+
+export function getContainerElementFromRender (render: RenderType): Element
+
+export function toSnapshotFromRender (render: RenderType): Record<PropertyKey, unknown> | null
+
+export function toSnapshotFromContainerElement (containerElement: Element): Record<PropertyKey, unknown> | null
+
+export function toSnapshotFromComponentElement (componentElement?: Element | null) : Record<PropertyKey, unknown> | null
+
+export function snapshotOf (element?: Element | null): Record<PropertyKey, unknown> | null
+
+export {
+  toSnapshotFromRender as toSnapshot
+}