@snups/rjsf-utils/src/lookupFromFormContext.ts

Utility functions for @snups/rjsf-core

import get from 'lodash/get';
import has from 'lodash/has';

import { FORM_CONTEXT_NAME, LOOKUP_MAP_NAME } from './constants';
import { FormContextType, RJSFSchema, Registry, StrictRJSFSchema } from './types';

/** Given a React JSON Schema Form registry or formContext object, return the value associated with `toLookup`. This
 * might be contained within the lookup map in the formContext. If no such value exists, return the `fallback`
 * value.
 *
 * @param regOrFc - The @rjsf registry or form context in which the lookup will occur
 * @param toLookup - The name of the field in the lookup map in the form context to get the value for
 * @param [fallback] - The fallback value to use if the form context does not contain a value for `toLookup`
 * @returns - The value associated with `toLookup` in the form context or `fallback`
 */
export default function lookupFromFormContext<
  T = any,
  S extends StrictRJSFSchema = RJSFSchema,
  F extends FormContextType = any,
>(regOrFc: Registry<T, S, F> | Registry<T, S, F>['formContext'], toLookup: string, fallback?: unknown) {
  const lookupPath = [LOOKUP_MAP_NAME];
  if (has(regOrFc, FORM_CONTEXT_NAME)) {
    lookupPath.unshift(FORM_CONTEXT_NAME);
  }
  return get(regOrFc, [...lookupPath, toLookup], fallback);
}