@elliemae/loan-field-renderers 26.2.2

package/dist/types/lib/renderer/base/hooks/fieldValue.d.ts

@@ -0,0 +1,31 @@
+import { HookBase } from './hookBase';
+import { FieldValueParamsT, FormattingOptionsT, ParsingOptionsT } from '../../types';
+export declare class FieldValue extends HookBase {
+    getFieldValue(fieldId: string): Promise<unknown>;
+    formatValue(params: {
+        fieldValue: unknown;
+        fieldFormat: string;
+        options: FormattingOptionsT;
+    }): unknown;
+    private formatByRendererType;
+    private formatTextValue;
+    private formatNumberValue;
+    private formatBooleanValue;
+    private formatDateValue;
+    private formatDropdownValue;
+    private formatZipValue;
+    useFieldValue(params: FieldValueParamsT): {
+        fieldValue: unknown;
+        setFieldValue: React.Dispatch<React.SetStateAction<unknown>>;
+    };
+    parseValue(params: {
+        fieldValue: unknown;
+        fieldFormat: string;
+        options: ParsingOptionsT;
+    }): unknown;
+    private parseTextValue;
+    private parseNumberValue;
+    private parseBooleanValue;
+    private parseDateValue;
+    private parseZipValue;
+}

package/dist/types/lib/renderer/base/hooks/hookBase.d.ts

@@ -0,0 +1,9 @@
+import { IBLL } from '../../../bll';
+/**
+ * Base class for all hooks
+ * Provides shared BLL instance
+ */
+export declare abstract class HookBase {
+    protected BLL: IBLL;
+    constructor(bll: IBLL);
+}

package/dist/types/lib/renderer/base/hooks/index.d.ts

@@ -0,0 +1,19 @@
+import { FieldMeta } from './fieldMeta';
+import { FieldValue } from './fieldValue';
+import { FieldDisabled } from './fieldDisabled';
+import { FieldLocked } from './fieldLocked';
+import { FieldValidation } from './fieldValidation';
+import { FieldSubscribers } from './fieldSubscribers';
+import { FieldGoTo } from './fieldGoTo';
+import { HookBase } from './hookBase';
+import { FieldDescription } from './fieldDescription';
+import { ViewModelT, VMConfigT } from '../../types';
+export interface Hooks extends FieldMeta, FieldValue, FieldDisabled, FieldLocked, FieldValidation, FieldSubscribers, FieldGoTo, FieldDescription {
+}
+export declare class Hooks extends HookBase {
+    useFieldInit(params: VMConfigT): ViewModelT;
+    useFieldGoTo(fieldId: string): {
+        isGoToField: boolean;
+        setIsGoToField: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    };
+}

package/dist/types/lib/renderer/base/renderer.d.ts

@@ -0,0 +1,43 @@
+import React from 'react';
+import { IBrComponentProps } from '@elliemae/business-rules';
+import { RendererPropsT, ViewModelT } from '../types';
+import { IBLL } from '../../bll';
+import { Hooks } from './hooks';
+export declare abstract class Renderer<T extends RendererPropsT = RendererPropsT> {
+    private BrComponent;
+    protected fieldFormat: string;
+    protected BLL: IBLL;
+    protected Hooks: Hooks;
+    protected BRWrapper: React.FC<IBrComponentProps>;
+    protected VM: ViewModelT;
+    protected Props: T;
+    constructor();
+    abstract render(): React.FC<T>;
+    private refreshFieldFromLoan;
+    private initCallbacks;
+    protected renderBR(): React.FC<IBrComponentProps>;
+    private syncVM;
+    private buildFormatOptions;
+    protected initVM(props: T): ViewModelT;
+    protected toggleLockStatus(fieldId: string, isLockedState: boolean): void;
+    protected buildValidationProps(validationResult: {
+        isValid: boolean;
+        message?: string;
+    } | null): {
+        validationMessage: string;
+        hasError: boolean;
+    };
+    protected getFormattedValue(fieldValue: unknown): unknown;
+    protected getParsedValue(fieldValue: unknown): unknown;
+    /**
+     * Sanitizes extra props by filtering out renderer-controlled properties.
+     * Prevents consumers from accidentally overriding internal state management.
+     * @template TExtra - Type of the extra props object
+     * @param {TExtra | undefined} extra - Additional props passed by the consumer
+     * @returns {Omit<TExtra, string>} Sanitized props object with controlled keys removed
+     * @example
+     * const sanitized = this.sanitize({ className: 'custom', onChange: () => {} });
+     * // Returns: { className: 'custom' } (onChange is filtered out)
+     */
+    protected sanitize<TExtra extends Record<string, unknown>>(extra: TExtra | undefined): Omit<TExtra, string>;
+}

package/dist/types/lib/renderer/base/rendererValidator.d.ts

@@ -0,0 +1,15 @@
+import { IRendererValidateParams } from '../types';
+export declare class RendererValidator {
+    private static readonly NUMERIC_FORMATS;
+    private static readonly BOOLEAN_FORMATS;
+    private static readonly DATE_FORMATS;
+    static validateRendererType({ rendererType, fieldFormat, }: Pick<IRendererValidateParams, 'rendererType' | 'fieldFormat'>): {
+        isValid: boolean;
+        expectedType: string;
+    };
+    static isNumericFormat(format?: string): boolean;
+    static isBooleanFormat(format?: string): boolean;
+    static isDateFormat(format?: string): boolean;
+    static isTextCompatibleFormat(format?: string): boolean;
+    static logMismatch({ fieldId, rendererType, fieldFormat, metadata, }: IRendererValidateParams): void;
+}

package/dist/types/lib/renderer/factory/index.d.ts

@@ -0,0 +1,5 @@
+import { RendererPropsT } from '../types';
+export declare class RendererFactory {
+    static create(type: string): React.FC<RendererPropsT>;
+    render(): React.FC<RendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/AddonRenderer.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { AddonRendererPropsT } from '../types';
+export declare class AddonRenderer extends Renderer<AddonRendererPropsT> {
+    protected renderPadLock({ fieldId, isLocked, isDisabled, onToggle, }: {
+        fieldId: string;
+        isLocked: boolean;
+        isDisabled?: boolean;
+        onToggle?: () => void;
+    }): import("react/jsx-runtime").JSX.Element;
+    render(): React.FC<AddonRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/CheckboxRenderer.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { CheckboxRendererPropsT } from '../types';
+export declare class CheckboxRenderer extends Renderer<CheckboxRendererPropsT> {
+    constructor();
+    render(): React.FC<CheckboxRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/DateRenderer.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { DateRendererPropsT, AddonRendererPropsT } from '../types';
+/**
+ * DateRenderer follows the same architecture pattern as TextRenderer.
+ * Leverages the base Renderer class for formatting/parsing via centralized BLL.
+ * Loan value stored as YYYY-MM-DD, UI displays as MM/DD/YYYY (configurable).
+ */
+export declare class DateRenderer extends Renderer<DateRendererPropsT> {
+    AddOnRenderer: React.FC<AddonRendererPropsT>;
+    constructor();
+    render(): React.FC<DateRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/DropdownRenderer/hook.d.ts

@@ -0,0 +1,23 @@
+import { DSComboboxT } from '@elliemae/ds-controlled-form';
+import { FieldOptionsT } from '../../types';
+interface Params {
+    isEditable?: boolean;
+    fieldValue: unknown;
+    baseOptions: FieldOptionsT[];
+    isLockField: boolean;
+    handlePersist: (rawValue: string | null) => void;
+    isLocked: boolean;
+    setIsSearchedField: React.Dispatch<React.SetStateAction<boolean>>;
+    fieldId: string;
+    onCreateCB?: (fieldId: string, value: string) => void;
+}
+export declare function useDropdownCreateSupport({ isEditable, fieldValue, baseOptions, isLockField, handlePersist, isLocked, setIsSearchedField, fieldId, onCreateCB, }: Params): {
+    effectiveOptions: FieldOptionsT[];
+    selectedOption: DSComboboxT.ItemOption | null;
+    createProps: {
+        onCreate: (createdLabel: string) => void;
+    } | {
+        onCreate?: undefined;
+    };
+};
+export {};

package/dist/types/lib/renderer/field-renderers/DropdownRenderer/index.d.ts

@@ -0,0 +1,12 @@
+import * as React from 'react';
+import { Renderer } from '../../base/renderer';
+import { DropdownRendererPropsT, AddonRendererPropsT } from '../../types';
+/**
+ * DropdownRenderer with controlled value sanitization, geo state data and editable support.
+ */
+export declare class DropdownRenderer extends Renderer<DropdownRendererPropsT> {
+    AddOnRenderer: React.FC<AddonRendererPropsT>;
+    constructor();
+    render(): React.FC<DropdownRendererPropsT>;
+}
+export default DropdownRenderer;

package/dist/types/lib/renderer/field-renderers/LargeTextRenderer.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { LargeTextRendererPropsT, AddonRendererPropsT } from '../types';
+/**
+ * LargeTextRenderer - A multi-line textarea renderer following the Renderer design pattern.
+ * Migrated from CommentComponent.jsx with full feature parity:
+ * - Multi-line text input with configurable rows
+ * - SSF integration for field value persistence
+ * - GTF highlighter support via BRWrapper
+ * - Validation support
+ * - Padlock/lock field support via AddonRenderer
+ */
+export declare class LargeTextRenderer extends Renderer<LargeTextRendererPropsT> {
+    AddOnRenderer: React.FC<AddonRendererPropsT>;
+    constructor();
+    render(): React.FC<LargeTextRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/NumberRenderer.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { NumberRendererPropsT } from '../types';
+export declare class NumberRenderer extends Renderer<NumberRendererPropsT> {
+    private AddOnRenderer;
+    constructor();
+    private useNumberMaskResult;
+    private isEmptyInput;
+    private handleOnBlur;
+    private getMaxLengthProp;
+    render(): React.FC<NumberRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/RadioGroupRenderer.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { RadioGroupRendererPropsT } from '../types';
+export declare class RadioGroupRenderer extends Renderer<RadioGroupRendererPropsT> {
+    constructor();
+    private onSelect;
+    render(): React.FC<RadioGroupRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/RadioRenderer.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { RadioRendererPropsT } from '../types';
+export declare class RadioRenderer extends Renderer<RadioRendererPropsT> {
+    constructor();
+    private onSelect;
+    render(): React.FC<RadioRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/TextRenderer.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { TextRendererPropsT, EmailRendererPropsT, AddonRendererPropsT } from '../types';
+export declare class TextRenderer extends Renderer<TextRendererPropsT | EmailRendererPropsT> {
+    AddOnRenderer: React.FC<AddonRendererPropsT>;
+    constructor();
+    render(): React.FC<TextRendererPropsT | EmailRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/ToggleRenderer.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { Renderer } from '../base/renderer';
+import { ToggleRendererPropsT } from '../types';
+/**
+ * ToggleRenderer - A boolean toggle field renderer following the field-renderers architecture.
+ *
+ * Architecture Notes:
+ * - Extends base Renderer<ToggleRendererPropsT> for shared infrastructure (BLL, Hooks, BRWrapper, VM)
+ * - Uses initVM() for centralized state management (value, metadata, validation, disabled state)
+ * - Leverages BRWrapper for business rules integration and loan change subscriptions
+ * - Implements the render() template method returning a memoized functional component
+ * - Follows the same patterns as CheckboxRenderer for boolean field handling
+ *
+ * Migration Notes from toggle-button.tsx:
+ * - Replaced SSFWrapper.getFieldValue with BLL.SSF (via initVM hook)
+ * - Replaced useSearchedField custom hook with Hooks.useFieldInit integration
+ * - Replaced forceUpdate prop with BRWrapper's automatic loan change subscription
+ * - Replaced BRWrapper component import with renderBR() template method
+ * - Moved label handling to BRWrapper label prop for consistency
+ */
+export declare class ToggleRenderer extends Renderer<ToggleRendererPropsT> {
+    constructor();
+    render(): React.FC<ToggleRendererPropsT>;
+}

package/dist/types/lib/renderer/field-renderers/ZipCodeRenderer/helper.d.ts

@@ -0,0 +1,48 @@
+import { GeoFields, ZipCodeCityDataT, ZipCodeAutocompleteOptionT, DebounceOptionsT } from '../../types';
+export declare const useDebouncedCallback: <T extends unknown[]>(callback: (...args: T) => void | Promise<void>, waitTimeout?: number, options?: DebounceOptionsT) => (...args: T) => void;
+/**
+ * ZipCodeHelper - Utility class for zip code data formatting and validation
+ *
+ * Provides centralized methods for:
+ * - City data normalization
+ * - Option label formatting
+ * - Autocomplete option building
+ * - Address field validation
+ */
+export declare class ZipCodeHelper {
+    private constructor();
+    private static readonly SECTION_OPTION;
+    static readonly DEFAULT_COUNTRY_CODE = "US";
+    /**
+     * Normalizes city data from various API response formats
+     * Handles both uppercase and lowercase property names
+     * @param cityData - The city data object to normalize
+     * @returns Normalized object with lowercase property names
+     */
+    static normalizeCityData(cityData: ZipCodeCityDataT | null): {
+        city: string;
+        state: string;
+        county: string;
+    };
+    /**
+     * Formats a city data option into a readable label
+     * Format: "City - County - State"
+     * @param option - The city data to format
+     * @returns Formatted string label
+     */
+    static formatOptionLabel(option: ZipCodeCityDataT): string;
+    /**
+     * Builds autocomplete options from zip code lookup data
+     * When multiple cities exist for a zip code, adds a section header
+     * @param zip - The zip code string
+     * @param data - Array of city data for the zip code
+     * @returns Array of autocomplete options
+     */
+    static buildOptions(zip: string, data: ZipCodeCityDataT[]): ZipCodeAutocompleteOptionT[];
+    /**
+     * Validates whether any geo fields contain non-empty address data
+     * @param geoFields - Optional geo fields object to validate
+     * @returns True if any geo field has non-empty string value
+     */
+    static hasAddressTargets(geoFields?: GeoFields): boolean;
+}

package/dist/types/lib/renderer/field-renderers/ZipCodeRenderer/hook.d.ts

@@ -0,0 +1,17 @@
+import { GeoFields, ZipCodeCityDataT, ZipCodeOptionT, ZipCodeAutocompleteOptionT } from '../../types';
+import { SSF } from '../../../bll/ssf';
+type ZipCodeApi = Pick<SSF, 'getZipCodeOptions' | 'getZipCodeOptionsWithLatLong' | 'setFieldsValues'>;
+type UseZipCodeLookupParams = {
+    ssf: ZipCodeApi;
+    onGeoLookupComplete?: (zipCode: string, cityData: ZipCodeCityDataT) => void;
+    useLatLong?: boolean;
+    isForeignAddress?: boolean;
+    geoFields?: GeoFields;
+};
+export declare const useZipCodeLookup: ({ ssf, onGeoLookupComplete, useLatLong, isForeignAddress, geoFields, }: UseZipCodeLookupParams) => {
+    readonly options: ZipCodeAutocompleteOptionT[];
+    readonly searchZipCode: (zip: string) => void;
+    readonly handleOptionSelect: (label?: string | null) => ZipCodeOptionT | null;
+    readonly clearOptions: () => void;
+};
+export {};

package/dist/types/lib/renderer/field-renderers/ZipCodeRenderer/index.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { Renderer } from '../../base/renderer';
+import { ZipCodeRendererPropsT, AddonRendererPropsT } from '../../types';
+export declare class ZipCodeRenderer extends Renderer<ZipCodeRendererPropsT> {
+    AddOnRenderer: React.FC<AddonRendererPropsT>;
+    constructor();
+    render(): React.FC<ZipCodeRendererPropsT>;
+}
+export default ZipCodeRenderer;

package/dist/types/lib/renderer/index.d.ts

@@ -0,0 +1,2 @@
+import { FieldRenderer } from './FieldRenderer';
+export { FieldRenderer };

package/dist/types/lib/renderer/styles.d.ts

@@ -0,0 +1,7 @@
+import { Theme } from '@elliemae/pui-theme';
+export declare const EmptyLabel: import("styled-components").StyledComponent<"label", any, {}, never>;
+export declare const StyledDateTimePicker: import("styled-components").StyledComponent<{
+    (props: import("@elliemae/ds-form-date-time-picker").DSControlledDateTimePickerT.Props): JSX.Element;
+    displayName: string;
+}, any, {}, never>;
+export declare const theme: Theme;