react-browser-form/src/utils/setDebugData.ts

<div align="center"> <a href="https://deniskabana.github.io/react-browser-form/introduction" title="React Browser Form - Form management in React made simple for browsers."> <img src="https://raw.githubusercontent.com/deniskabana/react-browser-form/

import { DataFlowEvent, BrowserFormOptions, BrowserFormReturnType } from "../types";

export const DEBUG_CHANGE_EVENT = "rdf_debug_change";

// Intentionally declared outside of types.ts due to usage intentions
// Most fields are populated when an action was initiated
export interface DebugData<Schema> {
  /** All of the returned data - includes listeners, isDirty, errors, names, etc. */
  returnData: BrowserFormReturnType<Schema>;
  /** The reason for change the event handlers provide */
  changeReason?: string;
  /** React browser form's internal data flow event - includes source and type of the event */
  event?: DataFlowEvent<Schema>;
  /** Updated formState after event transformations */
  formState?: Schema;
  /** Whether the form has already been submitted */
  isSubmitted?: boolean;
}

/**
 * Set debug data - useful for docs, testing, debugging and understanding the data flow
 * **NEVER USE THIS FOR ANYTHING ELSE.**
 */
export function setDebugData<Schema>(
  data: Partial<DebugData<Schema>>,
  options: BrowserFormOptions<any>,
  shouldDispatch = false,
) {
  if (!options.debug || typeof window === "undefined") return;

  const rdfDebugChangeEvent = new CustomEvent(DEBUG_CHANGE_EVENT, { detail: options.name });

  // Set up a new debug object if it doesn't exist yet
  if (!(window as any).__rdf_debug) (window as any).__rdf_debug = {};
  if (!(window as any).__rdf_debug[options.name]) (window as any).__rdf_debug[options.name] = {};

  // Add or replace fields on the debug object
  // This object might be replaced with a Proxy, do not overwrite it
  for (let key in data) {
    (window as any).__rdf_debug[options.name][key] = (data as any)[key];
  }

  if (shouldDispatch) {
    // Defer execution
    setTimeout(() => document.dispatchEvent(rdfDebugChangeEvent));
  }
}