react-refresh 0.17.0: getFamilyByID

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify react-refresh.getFamilyByID in pkg:npm/react-refresh@0.17.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/react-refresh@0.17.0
Demonstrate these symbols/APIs:
  - react-refresh.getFamilyByID

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:9a9a0f9df4ec6fa09b7b89baf3d6d7a654f54ba98600797e413363346fbbbe25","contract":["getFamilyByID returns undefined for an unregistered component identifier","getFamilyByID returns the family object with current pointing to the registered component type","getFamilyByID returns the identical family instance as getFamilyByType for a registered component","getFamilyByID retains family identity and updates current when a new component version is registered and refreshed","getFamilyByID resolves nested families created for memo or forwardRef components"],"goal":"verify react-refresh.getFamilyByID in pkg:npm/react-refresh@0.17.0","kind":"HOW","packages":["pkg:npm/react-refresh@0.17.0"],"schemaVersion":1,"symbols":["react-refresh.getFamilyByID"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/react-refresh@0.17.0"],"schemaVersion":1,"subject":"pkg:npm/react-refresh@0.17.0","symbols":["react-refresh.getFamilyByID"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-react-refresh-family-by-id",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-react-refresh-family-by-id",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "react-refresh": "0.17.0"
      }
    },
    "node_modules/react-refresh": {
      "version": "0.17.0",
      "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.17.0.tgz",
      "integrity": "sha512-z6F7K9bV85EfseRCp2bzrpyQ0Gkw1uLoCel9XBVWPg/TjRj94SkJzUTGfOa4bs7iJvBWtQG0Wq7wnI0syw3EBQ==",
      "license": "MIT",
      "engines": {
        "node": ">=0.10.0"
      }
    }
  }
}

{
  "name": "sample-react-refresh-family-by-id",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "react-refresh": "0.17.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify react-refresh.getFamilyByID in pkg:npm/react-refresh@0.17.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/react-refresh@0.17.0"
  ],
  "symbols": [
    "react-refresh.getFamilyByID"
  ]
}

import refreshRuntimeModule from "react-refresh/runtime";

export const RefreshRuntime =
  refreshRuntimeModule && typeof refreshRuntimeModule === "object" && "default" in refreshRuntimeModule
    ? refreshRuntimeModule.default
    : refreshRuntimeModule;

/**
 * Returns the family object associated with a given component family identifier,
 * or undefined if the identifier has not been registered.
 *
 * @param {string} id
 * @returns {object|undefined}
 */
export function getFamilyByID(id) {
  return RefreshRuntime.getFamilyByID(id);
}

/**
 * Returns the family object associated with a given component type,
 * or undefined if the component type has not been registered.
 *
 * @param {Function|object} type
 * @returns {object|undefined}
 */
export function getFamilyByType(type) {
  return RefreshRuntime.getFamilyByType(type);
}

/**
 * Registers a component type with a stable identifier in the Fast Refresh runtime.
 *
 * @param {Function|object} type
 * @param {string} id
 */
export function register(type, id) {
  RefreshRuntime.register(type, id);
}

/**
 * Triggers a React Refresh update pass, resolving pending registrations
 * and updating the current pointer of registered component families.
 *
 * @returns {object|null}
 */
export function performReactRefresh() {
  return RefreshRuntime.performReactRefresh();
}

import assert from "node:assert/strict";
import refreshRuntimeModule from "react-refresh/runtime";
import {
  RefreshRuntime,
  getFamilyByID,
  getFamilyByType,
  register,
  performReactRefresh
} from "../src/index.mjs";

const rawRuntime =
  refreshRuntimeModule && typeof refreshRuntimeModule === "object" && "default" in refreshRuntimeModule
    ? refreshRuntimeModule.default
    : refreshRuntimeModule;

// Contract 1: getFamilyByID returns undefined for an unregistered component identifier
{
  const unregistered = getFamilyByID("unregistered_component_id");
  assert.equal(unregistered, undefined);
  assert.equal(rawRuntime.getFamilyByID("unregistered_component_id"), undefined);
}

// Contract 2: getFamilyByID returns the family object with current pointing to the registered component type
function HeaderV1() {
  return "header v1";
}
{
  register(HeaderV1, "HeaderComponent");
  const family = getFamilyByID("HeaderComponent");
  assert.notEqual(family, undefined);
  assert.equal(typeof family, "object");
  assert.equal(family.current, HeaderV1);
}

// Contract 3: getFamilyByID returns the identical family instance as getFamilyByType for a registered component
{
  const familyFromId = getFamilyByID("HeaderComponent");
  const familyFromType = getFamilyByType(HeaderV1);
  assert.notEqual(familyFromId, undefined);
  assert.strictEqual(familyFromId, familyFromType);
}

// Contract 4: getFamilyByID retains family identity and updates current when a new component version is registered and refreshed
function HeaderV2() {
  return "header v2";
}
{
  const initialFamily = getFamilyByID("HeaderComponent");
  register(HeaderV2, "HeaderComponent");

  // Before performReactRefresh is executed, family.current remains the original component
  assert.strictEqual(getFamilyByID("HeaderComponent"), initialFamily);
  assert.strictEqual(initialFamily.current, HeaderV1);

  // After performReactRefresh, family reference is preserved while current points to HeaderV2
  performReactRefresh();
  const updatedFamily = getFamilyByID("HeaderComponent");
  assert.strictEqual(updatedFamily, initialFamily);
  assert.strictEqual(updatedFamily.current, HeaderV2);
}

// Contract 5: getFamilyByID resolves nested families created for memo or forwardRef components
const MemoizedComponent = {
  $$typeof: Symbol.for("react.memo"),
  type: function InnerComponent() {
    return "memoized inner";
  }
};
{
  register(MemoizedComponent, "MemoComponent");
  const outerFamily = getFamilyByID("MemoComponent");
  const innerFamily = getFamilyByID("MemoComponent$type");

  assert.notEqual(outerFamily, undefined);
  assert.strictEqual(outerFamily.current, MemoizedComponent);

  assert.notEqual(innerFamily, undefined);
  assert.strictEqual(innerFamily.current, MemoizedComponent.type);
}

console.log("All react-refresh.getFamilyByID contract tests passed successfully.");