@fuf-stack/uniform 1.11.0 → 1.11.2

package/dist/useUniformField-ClprfrES.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useUniformField-ClprfrES.js","names":["labelNode: ReactNode | null","FieldCopyTestIdButton","FieldValidationError"],"sources":["../src/hooks/useUniformField/useUniformField.tsx","../src/hooks/useUniformField/index.ts"],"sourcesContent":["import type { ReactNode } from 'react';\nimport type { FieldError, FieldValues, Path } from 'react-hook-form';\nimport type { InputValueTransform } from '../useInputValueTransform/useInputValueTransform';\n\nimport React from 'react';\n\nimport { isTestEnvironment } from '@fuf-stack/pixel-utils';\nimport { useDebounce } from '@fuf-stack/pixels';\n\nimport { FieldCopyTestIdButton } from '../../partials/FieldCopyTestIdButton';\nimport { FieldValidationError } from '../../partials/FieldValidationError';\nimport { useController } from '../useController/useController';\nimport { useFormContext } from '../useFormContext/useFormContext';\nimport { useInput } from '../useInput/useInput';\nimport { useInputValueTransform } from '../useInputValueTransform/useInputValueTransform';\n\n/**\n * Debounce invalid state changes to prevent UI flicker on rapid changes.\n *\n * Primary purpose: Reduce UI flicker when validation state changes rapidly\n * (e.g., during fast typing). Without debouncing, error messages would flash\n * in/out rapidly, creating a poor UX.\n *\n * Secondary benefit: When animations are enabled (default), gives time for\n * enter/exit animations to complete smoothly.\n *\n * Behavior:\n * - Debounces both true → false and false → true transitions by `delayMs`\n * - Disabled in test environments for immediate snapshots\n */\nconst useDebouncedInvalid = (invalid: boolean, delayMs: number) => {\n  const debouncedInvalid = useDebounce(invalid, delayMs);\n\n  // Disable debouncing in test environments for immediate snapshots\n  if (isTestEnvironment()) {\n    return invalid;\n  }\n\n  return debouncedInvalid;\n};\n\nexport interface UseUniformFieldParams<\n  TFieldValues extends FieldValues = FieldValues,\n  TDisplay = unknown,\n> {\n  /** Form field name */\n  name: Path<TFieldValues> & string;\n  /** Custom aria-label for accessibility. If not provided, falls back to field name when no visible label exists */\n  ariaLabel?: string;\n  /** Disable the field */\n  disabled?: boolean;\n  /** Optional label content */\n  label?: ReactNode;\n  /** Optional explicit test id used to build stable test ids */\n  testId?: string;\n  /** Optional value transformation between form and display values */\n  transform?: InputValueTransform<TDisplay>;\n  /** Input type for special number handling */\n  type?: 'text' | 'number' | 'password';\n}\n\nexport interface UseUniformFieldReturn<\n  TFieldValues extends FieldValues = FieldValues,\n> {\n  /** Computed aria-label fallback (field name) when no visible label exists. Components can override based on their accessibility needs (e.g., if placeholder provides sufficient context) */\n  ariaLabel: string | undefined;\n  /** react-hook-form control instance for advanced integrations */\n  control: ReturnType<typeof useFormContext<TFieldValues>>['control'];\n  /** Debug mode from Uniform provider */\n  debugMode: ReturnType<typeof useFormContext<TFieldValues>>['debugMode'];\n  /** Current value used to initialize uncontrolled components */\n  defaultValue: unknown;\n  /** Whether the field is currently disabled (from RHF) */\n  disabled: boolean | undefined;\n  /** Validation error(s) for the field */\n  error: FieldError[] | undefined;\n  /** Pre-built errorMessage node to plug into components */\n  errorMessage: ReactNode | null;\n  /** RHF controller field with transformed value/onChange (use this for simple components) */\n  field: ReturnType<typeof useController<TFieldValues>>['field'];\n  /** Helper to spread standardized error message props to underlying components */\n  getErrorMessageProps: ReturnType<typeof useInput>['getErrorMessageProps'];\n  /** Helper to spread standardized helper wrapper props (for spacing/animation) */\n  getHelperWrapperProps: ReturnType<typeof useInput>['getHelperWrapperProps'];\n  /** Helper to spread standardized label props to underlying components */\n  getLabelProps: ReturnType<typeof useInput>['getLabelProps'];\n  /** Access current form values (converted to validation-friendly format) */\n  getValues: ReturnType<typeof useFormContext<TFieldValues>>['getValues'];\n  /** Whether the field should show invalid state (debounced for smooth animations). True when field is invalid AND (dirty OR touched OR submitted) */\n  invalid: boolean;\n  /** Computed label node including optional test id copy button */\n  label: ReactNode | null;\n  /** onBlur handler from controller */\n  onBlur: ReturnType<typeof useController<TFieldValues>>['field']['onBlur'];\n  /** onChange handler from controller (with transform applied) */\n  onChange: ReturnType<typeof useController<TFieldValues>>['field']['onChange'];\n  /** Ref to forward to underlying control */\n  ref: ReturnType<typeof useController<TFieldValues>>['field']['ref'];\n  /** Whether the field is required according to validation schema */\n  required: boolean;\n  /** Reset a specific field in the form */\n  resetField: ReturnType<typeof useFormContext<TFieldValues>>['resetField'];\n  /** Generated HTML data-testid for the field */\n  testId: string;\n}\n\n/**\n * Combines frequently used form field logic into a single hook.\n *\n * Provides:\n * - Enhanced form context (validation-aware state, `testId`, value transforms)\n * - Controller field with nullish conversion handling\n * - Value transformation via `transform` prop:\n *   • Allows disentangled display and form values (e.g., string ↔ object, boolean ↔ array)\n *   • Automatically applies `toDisplayValue` to field value for components\n *   • Automatically applies `toFormValue` to display value when onChange is called\n *   • Works with `type` prop for automatic number/string conversion\n *   • Examples: storing objects while displaying strings, storing booleans as arrays, enriching values with metadata\n * - Debounced `invalid` state with smart timing:\n *   • `true` (field becomes invalid): applies immediately so errors show right away\n *   • `false` (field becomes valid): delayed 200ms to allow smooth exit animations\n *   • Respects `prefers-reduced-motion` by skipping delays when user prefers reduced motion\n * - Smart `invalid` visibility (via `showInvalid`):\n *   • Shows errors when field is dirty OR touched OR form has been submitted\n *   • Prevents showing errors on pristine/untouched fields for better UX\n *   • Works well for all field types (text inputs, checkboxes, radios, arrays)\n * - Prebuilt `errorMessage` React node using `FieldValidationError`\n * - Computed `label` node which appends a `FieldCopyTestIdButton` in\n *   `debug-testids` mode\n * - `defaultValue` for uncontrolled defaults and all usual field handlers\n * - Access to form utilities: `control`, `getValues`, `resetField`\n * - Presentation helpers: `getLabelProps`, `getErrorMessageProps`,\n *   `getHelperWrapperProps` for consistent wiring to underlying UI components\n */\nexport const useUniformField = <\n  TFieldValues extends FieldValues = FieldValues,\n  TDisplay = unknown,\n>(\n  params: UseUniformFieldParams<TFieldValues, TDisplay>,\n): UseUniformFieldReturn<TFieldValues> => {\n  const {\n    name,\n    ariaLabel: customAriaLabel,\n    disabled = false,\n    testId: explicitTestId,\n    label,\n    type,\n    transform,\n  } = params;\n\n  const {\n    control,\n    debugMode,\n    formState: { submitCount },\n    getFieldState,\n    getValues,\n    resetField,\n  } = useFormContext<TFieldValues>();\n\n  const {\n    error,\n    invalid: rawInvalid,\n    isDirty,\n    isTouched,\n    required,\n    testId,\n  } = getFieldState(name, explicitTestId);\n\n  const { field } = useController<TFieldValues>({\n    control,\n    disabled,\n    name,\n  });\n  const {\n    onChange: fieldOnChange,\n    value: fieldValue,\n    disabled: isDisabled,\n    onBlur,\n    ref,\n  } = field;\n\n  // Get transform utilities (but don't apply them automatically)\n  // Components can choose how to use them (directly or via useInputValueDebounce)\n  const { toDisplayValue, toFormValue } = useInputValueTransform<TDisplay>({\n    type,\n    transform,\n  });\n\n  // For components without special needs: apply transform to value and onChange\n  const transformedValue = toDisplayValue(fieldValue);\n  const transformedOnChange = (eventOrValue: TDisplay | React.ChangeEvent) => {\n    // Extract value from event or use value directly\n    const displayValue =\n      (eventOrValue as React.ChangeEvent<HTMLInputElement>)?.target?.value ??\n      eventOrValue;\n    const formValue = toFormValue(displayValue as TDisplay);\n    fieldOnChange(formValue as typeof fieldValue);\n  };\n\n  const defaultValue = (getValues() as Record<string, unknown>)?.[\n    name as string\n  ];\n\n  /**\n   * Determine when to show the invalid state to the user.\n   *\n   * Show errors when the field is invalid AND any of these conditions are met:\n   *   - Field is dirty (value changed from initial) - good for checkboxes/radios/arrays\n   *   - Field is touched (focused and blurred) - good for text inputs\n   *   - Form has been submitted - shows all errors after submit attempt\n   *\n   * This prevents showing errors on pristine/untouched fields for better UX.\n   * Examples:\n   *   - Text input: User loads form with empty required field → no error shown yet\n   *   - Text input: User focuses and blurs → error shows (via isTouched)\n   *   - Checkbox group: User clicks first checkbox → error shows immediately (via isDirty)\n   *   - Any field: User submits form → all errors show (via submitCount)\n   *\n   * The entire condition is debounced to prevent flickering and allow smooth animations\n   * when any of the states (invalid, isDirty, isTouched, submitCount) change.\n   */\n  const showInvalid = rawInvalid && (isDirty || isTouched || submitCount > 0);\n  const invalid = useDebouncedInvalid(showInvalid, 200);\n\n  // Build a label node that:\n  // - shows the provided label (unless explicitly set to false)\n  // - appends a copy-to-clipboard button for the test id in `debug-testids` mode\n  // Consumers can pass this directly to component `label` props\n  const showTestIdCopyButton = debugMode === 'debug-testids';\n  const labelNode: ReactNode | null =\n    !!label || showTestIdCopyButton ? (\n      <>\n        {label !== false ? label : null}\n        {showTestIdCopyButton ? (\n          <FieldCopyTestIdButton testId={testId} />\n        ) : null}\n      </>\n    ) : null;\n\n  // Ready-to-render error message; consumers can drop this into their\n  // component `errorMessage` prop without repeating mapping/markup\n  const errorMessage = <FieldValidationError error={error} testId={testId} />;\n\n  // Generate standardized props for label, helper wrapper and error message\n  // so consumers can spread them directly into UI components (e.g. HeroUI),\n  // keeping animations/spacing consistent across fields\n  const { getErrorMessageProps, getLabelProps, getHelperWrapperProps } =\n    useInput({\n      ref,\n      classNames: {\n        // set padding to 0 for error message exit animation\n        helperWrapper: 'p-0',\n      },\n      errorMessage: JSON.stringify(error),\n      isInvalid: invalid,\n      isRequired: required,\n      label,\n      labelPlacement: 'outside',\n    });\n\n  // Compute aria-label: prefer custom prop, then use string label if available, otherwise field name\n  // Components can further override this based on their specific accessibility needs\n  // (e.g., Input/TextArea may skip this if they have a meaningful placeholder)\n  const ariaLabel =\n    customAriaLabel ?? (typeof label === 'string' ? label : name);\n\n  return {\n    ariaLabel,\n    control,\n    debugMode,\n    defaultValue,\n    disabled: isDisabled,\n    error,\n    errorMessage,\n    field: {\n      ...field,\n      value: transformedValue as typeof field.value,\n      onChange: transformedOnChange as typeof field.onChange,\n    },\n    getErrorMessageProps,\n    getHelperWrapperProps,\n    getLabelProps,\n    getValues,\n    invalid,\n    label: labelNode,\n    onBlur,\n    onChange: transformedOnChange as typeof field.onChange,\n    ref,\n    required,\n    resetField,\n    testId,\n  };\n};\n","/* v8 ignore start */\n\nexport * from './useUniformField';\n\n/* v8 ignore stop */\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,MAAM,uBAAuB,SAAkB,YAAoB;CACjE,MAAM,mBAAmB,YAAY,SAAS,QAAQ;AAGtD,KAAI,mBAAmB,CACrB,QAAO;AAGT,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgGT,MAAa,mBAIX,WACwC;CACxC,MAAM,EACJ,MACA,WAAW,iBACX,WAAW,OACX,QAAQ,gBACR,OACA,MACA,cACE;CAEJ,MAAM,EACJ,SACA,WACA,WAAW,EAAE,eACb,eACA,WACA,eACE,gBAA8B;CAElC,MAAM,EACJ,OACA,SAAS,YACT,SACA,WACA,UACA,WACE,cAAc,MAAM,eAAe;CAEvC,MAAM,EAAE,UAAU,cAA4B;EAC5C;EACA;EACA;EACD,CAAC;CACF,MAAM,EACJ,UAAU,eACV,OAAO,YACP,UAAU,YACV,QACA,QACE;CAIJ,MAAM,EAAE,gBAAgB,gBAAgB,uBAAiC;EACvE;EACA;EACD,CAAC;CAGF,MAAM,mBAAmB,eAAe,WAAW;CACnD,MAAM,uBAAuB,iBAA+C;AAM1E,gBADkB,YAFf,cAAsD,QAAQ,SAC/D,aACqD,CACV;;CAG/C,MAAM,eAAgB,WAAW,GAC/B;CAsBF,MAAM,UAAU,oBADI,eAAe,WAAW,aAAa,cAAc,IACxB,IAAI;CAMrD,MAAM,uBAAuB,cAAc;CAC3C,MAAMA,YACJ,CAAC,CAAC,SAAS,uBACT,4CACG,UAAU,QAAQ,QAAQ,MAC1B,uBACC,oBAACC,iCAA8B,SAAU,GACvC,QACH,GACD;CAIN,MAAM,eAAe,oBAACC;EAA4B;EAAe;GAAU;CAK3E,MAAM,EAAE,sBAAsB,eAAe,0BAC3C,SAAS;EACP;EACA,YAAY,EAEV,eAAe,OAChB;EACD,cAAc,KAAK,UAAU,MAAM;EACnC,WAAW;EACX,YAAY;EACZ;EACA,gBAAgB;EACjB,CAAC;AAQJ,QAAO;EACL,WAHA,oBAAoB,OAAO,UAAU,WAAW,QAAQ;EAIxD;EACA;EACA;EACA,UAAU;EACV;EACA;EACA,OAAO;GACL,GAAG;GACH,OAAO;GACP,UAAU;GACX;EACD;EACA;EACA;EACA;EACA;EACA,OAAO;EACP;EACA,UAAU;EACV;EACA;EACA;EACA;EACD"}