renderer-package 1.2.32

package/dist/pages/systemAdmin/modules/formbuilder/types/field.d.ts

@@ -0,0 +1,817 @@
+import type { CSSProperties } from 'react';
+import type { ValidationRule } from './validation';
+import type { FieldCondition } from './condition';
+export type FieldType = 'text' | 'number' | 'email' | 'phone' | 'otp' | 'password' | 'url' | 'date' | 'time' | 'datetime' | 'daterange' | 'select' | 'multiselect' | 'radio' | 'checkbox' | 'checkboxgroup' | 'toggle' | 'terms' | 'textarea' | 'richtext' | 'file' | 'camera' | 'photoChoice' | 'signature' | 'rating' | 'slider' | 'table' | 'billingGrid' | 'aadhaar' | 'selectablelist' | 'asyncsearch' | 'section' | 'group' | 'columns' | 'divider' | 'header' | 'spacer' | 'sectionHeading' | 'textLabel' | 'status' | 'button' | 'editButton' | 'addmore' | 'customizeSections';
+export interface FieldOption {
+    label: string;
+    value: string;
+    disabled?: boolean;
+    icon?: string;
+    description?: string;
+    /** Checkbox group: inline text slot key; use `{input:slotKey}` in label */
+    inlineInputKey?: string;
+    inlineInputPlaceholder?: string;
+}
+/** Stored value for checkbox group fields (multi-select + optional inline label inputs). */
+export type CheckboxGroupValue = string | string[] | {
+    selected: string[];
+    inline?: Record<string, string>;
+};
+export type CheckboxGroupSelectionMode = 'single' | 'multiple' | 'multipleWithSelectAll';
+export type CheckboxGroupShape = 'square' | 'round';
+export interface FieldPosition {
+    order: number;
+    column?: number;
+    columnSpan?: number;
+    /** Number of grid rows this field spans (e.g. 2 for Rich Text / Textarea) */
+    rowSpan?: number;
+    /**
+     * When set, this field can share a grid cell with other fields that have the same
+     * `order`, `column`, and `cellGroupId` (up to three fields per cell). `cellSlot` orders them.
+     */
+    cellGroupId?: string;
+    /** 0 = first, 1 = second, 2 = third when multiple fields share a cell. */
+    cellSlot?: number;
+    /** How to lay out multiple fields in the same cell. */
+    sharedCellLayout?: 'stack' | 'row';
+}
+export interface FieldAppearance {
+    size?: 'sm' | 'md' | 'lg';
+    variant?: 'default' | 'filled' | 'outlined';
+    labelPlacement?: 'top' | 'left' | 'right' | 'center' | 'floating';
+    hideLabel?: boolean;
+    /**
+     * Custom class on the field block; only ever applied under the renderer root (e.g. `.iq-fbr`), not global.
+     * Hosts can target with `.iq-fbr .{className}`.
+     */
+    className?: string;
+    /** Min size of the control area (not the full grid cell) */
+    minWidth?: string;
+    minHeight?: string;
+    /**
+     * Width of the field block as a percentage of the **grid cell** (integer 1–100), matching SMS Studio metadata → appearance.
+     * With `widthMode: 'percent'` or when only `widthPercent` is set (percent mode).
+     * For **button** / **editButton** fields, set `widthMode: 'full'` or `widthPercent: 100` if the control should span the full grid cell (see package CHANGELOG).
+     */
+    widthPercent?: number;
+    /**
+     * `full` = full cell width; `percent` = use `widthPercent`.
+     * Use `full` (or `widthPercent: 100`) to restore full-width **button** / **editButton** controls after implicit intrinsic-width defaults.
+     */
+    widthMode?: 'full' | 'percent';
+    /**
+     * Horizontal placement when the block is narrower than the cell (`widthPercent` &lt; 100).
+     * Logical start/center/end/stretch for RTL readiness; **stretch** fills the grid cell width on the control column (matches Studio).
+     */
+    horizontalAlign?: 'start' | 'center' | 'end' | 'stretch';
+    /** Alias for `horizontalAlign` (schema / host compatibility). Studio saves lowercase **`stretch`**. */
+    contentAlign?: 'start' | 'center' | 'end' | 'stretch';
+    /**
+     * Vertical placement in the grid cell (designer metadata). Unset = **start** (top).
+     * Distinct from {@link verticalAlign}; takes precedence for grid main-axis (`justify-*`) when set.
+     */
+    contentVerticalAlign?: 'start' | 'center' | 'end';
+    /**
+     * Vertical placement when the cell is taller than content (e.g. `rowSpan` &gt; 1).
+     * Defaults to **stretch** so controls fill spanned row height when unset.
+     */
+    verticalAlign?: 'start' | 'center' | 'end' | 'stretch';
+    /** @deprecated Prefer `horizontalAlign` */
+    cellAlign?: 'start' | 'center' | 'end' | 'stretch';
+    /** @deprecated Prefer `verticalAlign` */
+    cellJustify?: 'start' | 'center' | 'end' | 'stretch';
+}
+/** Typography presets mapped to scoped styles inside `.iq-fbr`. */
+export type FieldFontToken = 'body' | 'heading' | 'label' | 'caption';
+/** Additive layout/styling from schema (renderer applies to grid cell + FieldWrapper). */
+export interface FieldUiConfig {
+    cellStyle?: CSSProperties;
+    wrapperStyle?: CSSProperties;
+    labelStyle?: CSSProperties;
+    descriptionStyle?: CSSProperties;
+    fontToken?: FieldFontToken;
+}
+/** Field visibility by user type, role, and user. Unset = no restriction (visible to all). */
+export interface FieldVisibility {
+    /** Show only to this user type (e.g. admin, faculty). Unset = all types. */
+    visibleToUserType?: string;
+    /** Role name (roleName) from roles API for the selected user type (e.g. academic_admin, associate_professor). Unset = all roles for that type. */
+    visibleToUserRole?: string;
+    /** When non-empty: show field only to these user IDs (whitelist). When empty/unset: no user-level restriction. */
+    visibleToUserIds?: string[];
+    /** @deprecated Prefer visibleToUserIds. Hide from these user IDs. Kept for backward compatibility. */
+    hiddenFromUserIds?: string[];
+}
+export interface FormField {
+    id: string;
+    type: FieldType;
+    name: string;
+    label: string;
+    description?: string;
+    placeholder?: string;
+    defaultValue?: unknown;
+    position: FieldPosition;
+    parentId?: string;
+    appearance?: FieldAppearance;
+    /** Additive layout + typography (renderer); omit for legacy forms */
+    ui?: FieldUiConfig;
+    validation?: ValidationRule[];
+    conditions?: FieldCondition[];
+    properties?: FieldProperties;
+    visibility?: FieldVisibility;
+    disabled?: boolean;
+    readOnly?: boolean;
+    hidden?: boolean;
+}
+export type TextLabelVariant = 'body' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+export type TextLabelContentLayout = 'single' | 'paragraph';
+export interface TextLabelFieldProperties {
+    /** Main text/HTML (placeholders). When unset, legacy uses field.label as body. */
+    textContent?: string;
+    contentLayout?: TextLabelContentLayout;
+    variant?: TextLabelVariant;
+    fontWeight?: 'normal' | 'medium' | 'bold';
+    italic?: boolean;
+    underline?: boolean;
+    textAlign?: 'left' | 'center' | 'right' | 'justify';
+    inlineFormat?: 'none' | 'markdown-lite';
+    /** When false, description uses body foreground styling instead of muted (default true) */
+    descriptionMuted?: boolean;
+    /** When true, fetch labelApiEndpoint on load for {labelapi:path} placeholders */
+    labelApiEnabled?: boolean;
+    labelApiEndpoint?: string;
+    labelApiMethod?: 'GET' | 'POST';
+    labelApiQueryParams?: Array<{
+        key: string;
+        value: string;
+    }>;
+    labelApiHeaders?: Array<{
+        key: string;
+        value: string;
+    }>;
+    labelApiBodyFields?: Array<{
+        key: string;
+        value: string;
+    }>;
+}
+export type FieldProperties = TextFieldProperties | OtpFieldProperties | NumberFieldProperties | SelectFieldProperties | CheckboxGroupFieldProperties | DateFieldProperties | FileFieldProperties | TableFieldProperties | BillingGridFieldProperties | SectionProperties | SliderFieldProperties | RatingFieldProperties | ToggleFieldProperties | ButtonFieldProperties | AddMoreFieldProperties | CustomizeSectionsFieldProperties | SectionHeadingProperties | HeaderProperties | StatusFieldProperties | SelectableListFieldProperties | EditButtonFieldProperties | AsyncSearchFieldProperties | TextLabelFieldProperties;
+export interface TextFieldProperties {
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    patternMessage?: string;
+    autoComplete?: string;
+    inputMode?: 'text' | 'numeric' | 'tel' | 'email' | 'url';
+    valueSource?: 'static' | 'api' | 'calculated' | 'conditional' | 'database';
+    apiEndpoint?: string;
+    apiMethod?: string;
+    apiKey?: string;
+    apiRealtime?: boolean;
+    apiAutoDetect?: boolean;
+    apiLabelField?: string;
+    apiValueField?: string;
+    apiQueryParams?: SelectFieldProperties['apiQueryParams'];
+    apiClientFilter?: SelectFieldProperties['apiClientFilter'];
+    apiHeaders?: SelectFieldProperties['apiHeaders'];
+    apiBodyFields?: SelectFieldProperties['apiBodyFields'];
+    apiAuth?: SelectFieldProperties['apiAuth'];
+    dependentFields?: string[];
+}
+export type DeriveFromDatePart = 'years' | 'months' | 'days';
+/** Auto-fill a number field from a date field (e.g. age years/months/days from DOB). Field stays editable. */
+export interface DeriveFromDateConfig {
+    sourceFieldName: string;
+    part: DeriveFromDatePart;
+    referenceDate?: 'today';
+}
+export interface OtpResendConfig {
+    /** When true, show resend link, countdown, and attempts below OTP boxes. */
+    enabled?: boolean;
+    resendApiEndpoint?: string;
+    resendApiMethod?: 'GET' | 'POST' | 'PUT' | 'PATCH';
+    resendApiHeaders?: Array<{
+        key: string;
+        value: string;
+    }>;
+    resendApiBodyFields?: Array<{
+        key: string;
+        value: string;
+    }>;
+    resendApiQueryParams?: Array<{
+        key: string;
+        value: string;
+    }>;
+    /** Seconds before resend is allowed again (default 60). */
+    cooldownSeconds?: number;
+    /** Default/max attempts when API does not return a value (default 3). */
+    maxAttempts?: number;
+    /** Dot path in prepopulate response for initial attempts (e.g. data.attempts_remaining). */
+    initialAttemptsPath?: string;
+    /** Dot path in resend API response for attempts (default data.attempts_remaining). */
+    attemptsResponsePath?: string;
+    /** Dot path in resend API response for cooldown override (default data.resend_cooldown_seconds). */
+    cooldownResponsePath?: string;
+    /** Dot path in prepopulate for initial cooldown (e.g. data.resend_cooldown_seconds). */
+    initialCooldownPath?: string;
+    /**
+     * Status line template. Placeholders: {seconds}, {attempts}, {resend}.
+     * Default: "Resend OTP in {seconds} sec · Attempts remaining: {attempts}"
+     */
+    statusTemplate?: string;
+    /** Clickable resend link label (default "Resend OTP"). */
+    resendLinkText?: string;
+}
+export interface OtpFieldProperties {
+    /** Number of OTP digit boxes (default 4). */
+    otpLength?: number;
+    /** When true (default), each box accepts digits only. */
+    numericOnly?: boolean;
+    /** Optional resend OTP block (timer + attempts + API). */
+    resend?: OtpResendConfig;
+}
+export interface NumberFieldProperties {
+    min?: number;
+    max?: number;
+    step?: number;
+    precision?: number;
+    prefix?: string;
+    suffix?: string;
+    allowNegative?: boolean;
+    deriveFromDate?: DeriveFromDateConfig;
+    valueSource?: 'static' | 'api' | 'calculated' | 'conditional' | 'database';
+    apiEndpoint?: string;
+    apiMethod?: string;
+    apiKey?: string;
+    apiRealtime?: boolean;
+    apiAutoDetect?: boolean;
+    apiLabelField?: string;
+    apiValueField?: string;
+    apiQueryParams?: SelectFieldProperties['apiQueryParams'];
+    apiClientFilter?: SelectFieldProperties['apiClientFilter'];
+    apiHeaders?: SelectFieldProperties['apiHeaders'];
+    apiBodyFields?: SelectFieldProperties['apiBodyFields'];
+    apiAuth?: SelectFieldProperties['apiAuth'];
+    dependentFields?: string[];
+}
+/** One step in a dropdown-built formula (field reference or operator) */
+export type FormulaStep = {
+    type: 'field';
+    fieldName: string;
+} | {
+    type: 'operator';
+    operator: '+' | '-' | '*' | '/';
+};
+/** Properties for Selectable list field: list from response/context, user selects subset */
+export interface SelectableListFieldProperties {
+    /** Key in submissionContext to read full list from (e.g. 'recipients'). If not set, list comes from field value (initial). */
+    dataSourceContextKey?: string;
+    /** Object key to show as row label (e.g. 'name', 'email') or dot path; defaults to 'name' then 'email'. Ignored when displayFields is set. */
+    labelField?: string;
+    /** Object key to use as unique value for each row (e.g. 'email'); defaults to 'email' or index */
+    valueField?: string;
+    /** Field keys to show in each row (e.g. ['name', 'personal_email']). When set, label is built by joining these values; otherwise labelField is used. */
+    displayFields?: string[];
+    /** Separator between displayFields values (e.g. ' | ', ' - '); default ' | ' */
+    displayFieldsSeparator?: string;
+    /** Show "Select all" checkbox */
+    showSelectAll?: boolean;
+    /** When true, all items are selected by default */
+    selectAllByDefault?: boolean;
+    /** Optional. Map API key -> source path in each selected item for submit (e.g. { "email": "personal_email" }). Only mapped keys are sent. */
+    submitFieldMapping?: Record<string, string>;
+}
+export interface SelectFieldProperties {
+    options: FieldOption[];
+    optionsSource?: 'static' | 'api' | 'database';
+    valueSource?: 'static' | 'calculated' | 'api' | 'database';
+    formula?: string;
+    /** Steps built from field/operator dropdowns; used to build formula string */
+    formulaSteps?: FormulaStep[];
+    dependentFields?: string[];
+    apiEndpoint?: string;
+    apiMethod?: string;
+    /** API key for authentication (e.g., X-CSCAPI-KEY header) */
+    apiKey?: string;
+    apiRealtime?: boolean;
+    /** Whether to auto-detect fields from API response */
+    apiAutoDetect?: boolean;
+    /** Field name in API response to use as label (e.g., "name", "username", "email") */
+    apiLabelField?: string;
+    /** Field name in API response to use as value (e.g., "id", "email", "username") */
+    apiValueField?: string;
+    /** Query parameters structured format */
+    apiQueryParams?: {
+        limit?: string;
+        page?: string;
+        sort?: string;
+        orderBy?: string;
+        custom?: Array<{
+            key: string;
+            value: string;
+        }>;
+    };
+    /** Client-side filter: filter options by matching a field value with form field value */
+    apiClientFilter?: {
+        /** Field name in API response to filter by (e.g., "state_name", "stateId") */
+        filterField: string;
+        /** Form field name to match against (e.g., "state") */
+        matchField: string;
+    };
+    /** Custom HTTP headers (supports {fieldName}, {ctx:key}, {token}) */
+    apiHeaders?: Array<{
+        key: string;
+        value: string;
+    }>;
+    /** Extra JSON body fields for POST/PUT/PATCH */
+    apiBodyFields?: Array<{
+        key: string;
+        value: string;
+    }>;
+    apiAuth?: {
+        type: 'none' | 'bearer' | 'apiKey' | 'basic';
+        token?: string;
+        headerName?: string;
+        apiKey?: string;
+        username?: string;
+        password?: string;
+    };
+    dbQuery?: {
+        table: string;
+        valueColumn: string;
+        labelColumn: string;
+        filters?: Record<string, unknown>;
+    };
+    searchable?: boolean;
+    clearable?: boolean;
+    creatable?: boolean;
+}
+export interface CheckboxGroupFieldProperties extends SelectFieldProperties {
+    selectionMode?: CheckboxGroupSelectionMode;
+    checkboxShape?: CheckboxGroupShape;
+    showSelectAll?: boolean;
+    selectAllByDefault?: boolean;
+    selectAllLabel?: string;
+    minSelections?: number;
+    maxSelections?: number;
+    /** When true, canvas/renderer use authored position.columnSpan/rowSpan instead of option-count heuristics. */
+    layoutUseManualFootprint?: boolean;
+}
+/**
+ * Typeahead / async search. Stored value is either a primitive string (api value) or, when
+ * `asyncSearchValueMode === 'object'` with non-empty `asyncSearchValueObjectKeys`, a flat
+ * `Record<string, string>` built from the selected row. Default / `'single'` / undefined = string.
+ */
+export interface AsyncSearchFieldProperties {
+    apiEndpoint?: string;
+    apiMethod?: 'GET' | 'POST';
+    /** Same as select API options: replace `{fieldName}` in URL/query when true; gate requests until URL placeholders + `dependentFields` are filled. */
+    apiRealtime?: boolean;
+    /** Field names that must have values (and trigger refetch when they change), same spirit as designer “depends on” for select. */
+    dependentFields?: string[];
+    /** Same shape as select: filter client-side when API returns a superset. */
+    apiClientFilter?: SelectFieldProperties['apiClientFilter'];
+    /** GET (default): query parameter name for the live search string. */
+    searchQueryParam?: string;
+    /** When true, send the search string in the JSON body (uses HTTP POST to `apiEndpoint` even if `apiMethod` is GET). */
+    searchInBody?: boolean;
+    /** Alias for `searchSchedule` (form-workflow-frontend). */
+    searchStrategy?: 'debounce' | 'throttle';
+    /** Alias for `intervalMs`. */
+    searchIntervalMs?: number;
+    /** POST: JSON template string; use `{{query}}` for the escaped search string, then select-style placeholders (`{ctx:…}`, `{field}` if `apiRealtime`). */
+    searchBodyTemplate?: string;
+    apiLabelField?: string;
+    /**
+     * When set and non-empty, option labels are composed by joining these fields (dot paths allowed).
+     * This ONLY affects display label; option value mapping remains governed by `apiValueField` + existing fallbacks.
+     */
+    apiLabelFields?: string[];
+    /** Separator for `apiLabelFields` composed labels. Default: " - " */
+    apiLabelSeparator?: string;
+    apiValueField?: string;
+    apiAutoDetect?: boolean;
+    /** Optional API key header (e.g. X-CSCAPI-KEY), same as select API options. */
+    apiKey?: string;
+    apiQueryParams?: SelectFieldProperties['apiQueryParams'];
+    /** Custom HTTP headers (supports {fieldName}, {ctx:key}, {token}) */
+    apiHeaders?: Array<{
+        key: string;
+        value: string;
+    }>;
+    /** Extra JSON body fields for POST/PUT/PATCH */
+    apiBodyFields?: Array<{
+        key: string;
+        value: string;
+    }>;
+    apiAuth?: SelectFieldProperties['apiAuth'];
+    /**
+     * Optional response normalization format. When undefined, renderer may auto-detect some known formats
+     * (e.g. strict ClinicalTables v3) without impacting other APIs.
+     */
+    apiResultsFormat?: 'default' | 'clinicaltables_v3' | 'tuple_array';
+    /**
+     * Optional config for non-standard API response shapes.
+     * - `clinicaltables_v3`: preset for ClinicalTables v3 `[... , rows]` tuple response.
+     * - `tuple_array`: generic “rows are tuples” response.
+     */
+    apiResultsConfig?: {
+        /** Where to read tuple rows from when response is an array-of-arrays container. Default: 3 (ClinicalTables). */
+        rowsIndex?: number;
+        /** If provided, read tuple rows from a nested path instead of a top-level index (dot path). */
+        rowsPath?: string;
+        /** Column names to map tuple indexes to object keys (e.g. ["code","name"]). */
+        columns?: string[];
+        /** Query param name to read column list from (e.g. sf=code,name). Default: "sf" */
+        columnsQueryParam?: string;
+        /** Separator for columnsQueryParam value. Default: "," */
+        columnsQueryParamSeparator?: string;
+    };
+    searchSchedule?: 'debounce' | 'throttle';
+    intervalMs?: number;
+    minQueryLength?: number;
+    maxResults?: number;
+    clearable?: boolean;
+    /** When prepopulate sets `value` without a prior selection, show this label in the input. */
+    initialDisplayLabel?: string;
+    /** When `'object'` and `asyncSearchValueObjectKeys` has at least one non-empty key, form value is a flat string record from the row; otherwise same as `'single'` (string). */
+    asyncSearchValueMode?: 'single' | 'object';
+    /** Keys (dot paths allowed) to read from the selected row into the stored object; property names in the output match these strings (trimmed). Ignored when not in object mode or when empty (falls back to string value). */
+    asyncSearchValueObjectKeys?: string[];
+}
+export interface DateFieldProperties {
+    minDate?: string | 'today';
+    maxDate?: string | 'today';
+    disabledDates?: string[];
+    disabledDaysOfWeek?: number[];
+    dateFormat?: string;
+    showTime?: boolean;
+}
+export interface FileFieldProperties {
+    accept?: string[];
+    maxSize?: number;
+    maxFiles?: number;
+    multiple?: boolean;
+    uploadTo?: 'supabase' | 'external';
+    bucket?: string;
+}
+export interface TableFieldProperties {
+    columns: FormField[];
+    minRows?: number;
+    maxRows?: number;
+    allowAddRow?: boolean;
+    allowDeleteRow?: boolean;
+    allowReorder?: boolean;
+    /** Minimum width for table in canvas/preview (e.g. '800px', '60rem', '100%'). Table-only; allows wider display without changing form grid columns. */
+    minWidth?: string;
+}
+export type BillingGridAlign = 'left' | 'center' | 'right';
+/** Fallback until API/formula/calc provides a value; may be empty string. */
+export type BillingCellDefaultValue = string;
+export interface BillingGridTextStyle {
+    fontSize?: 'xs' | 'sm' | 'base' | 'lg' | 'xl';
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    color?: string;
+}
+/** Shared per-cell layout + typography (all {@link BillingCellSource} variants). */
+export type BillingCellCommonProps = {
+    align?: BillingGridAlign;
+    cellStyle?: BillingGridTextStyle;
+    /** Unique key for formulas (e.g. consultation_fee_unit_price). */
+    cellKey?: string;
+};
+export type BillingCellSource = ({
+    kind: 'static';
+    value: string;
+} & BillingCellCommonProps) | ({
+    kind: 'label';
+} & BillingCellCommonProps) | ({
+    kind: 'input';
+    inputType: 'number' | 'text';
+    defaultValue?: BillingCellDefaultValue;
+} & BillingCellCommonProps) | ({
+    kind: 'currency';
+    mode?: 'editable' | 'static' | 'api';
+    value?: string;
+    path?: string;
+    defaultValue?: BillingCellDefaultValue;
+} & BillingCellCommonProps) | ({
+    kind: 'api';
+    path: string;
+    defaultValue?: BillingCellDefaultValue;
+} & BillingCellCommonProps) | ({
+    kind: 'formula';
+    expression: string;
+    defaultValue?: BillingCellDefaultValue;
+} & BillingCellCommonProps);
+export interface BillingGridColumn {
+    id: string;
+    key: string;
+    label: string;
+    format?: 'text' | 'number' | 'currency' | 'percent';
+    align?: BillingGridAlign;
+    headerStyle?: BillingGridTextStyle;
+}
+export interface BillingStaticRow {
+    id: string;
+    label: string;
+    labelStyle?: BillingGridTextStyle;
+    cells: Record<string, BillingCellSource>;
+}
+export interface BillingDynamicBlock {
+    id: string;
+    label?: string;
+    labelStyle?: BillingGridTextStyle;
+    apiArrayPath?: string;
+    rowIdField?: string;
+    cells: Record<string, BillingCellSource>;
+}
+export type BillingGridRowSlot = {
+    kind: 'static';
+    row: BillingStaticRow;
+} | {
+    kind: 'dynamic';
+    block: BillingDynamicBlock;
+};
+export interface BillingGridFieldProperties {
+    columns: BillingGridColumn[];
+    rowSlots: BillingGridRowSlot[];
+    gridTitle?: string;
+    gridTitleStyle?: BillingGridTextStyle;
+    minWidth?: string;
+    currencySymbol?: string;
+    emptyDisplay?: string;
+    valueSource?: 'static' | 'api' | 'calculated' | 'conditional' | 'database';
+    apiEndpoint?: string;
+    apiMethod?: string;
+    apiKey?: string;
+    apiRealtime?: boolean;
+    apiQueryParams?: {
+        limit?: string;
+        page?: string;
+        sort?: string;
+        orderBy?: string;
+        custom?: Array<{
+            key: string;
+            value: string;
+        }>;
+    };
+    apiHeaders?: Array<{
+        key: string;
+        value: string;
+    }>;
+    apiBodyFields?: Array<{
+        key: string;
+        value: string;
+    }>;
+    apiAuth?: {
+        type: 'none' | 'bearer' | 'apiKey' | 'basic';
+        token?: string;
+        headerName?: string;
+        apiKey?: string;
+        username?: string;
+        password?: string;
+    };
+    dependentFields?: string[];
+    /** Dot path into API JSON before row/cell merge (e.g. data.data). */
+    apiResponsePath?: string;
+}
+export interface BillingGridRowValue {
+    slotId: string;
+    rowKind: 'static' | 'dynamic';
+    rowInstanceId: string;
+    label?: string;
+    values: Record<string, unknown>;
+}
+export interface BillingGridValue {
+    rows: BillingGridRowValue[];
+}
+export interface SectionProperties {
+    collapsible?: boolean;
+    defaultCollapsed?: boolean;
+    columns?: 1 | 2 | 3 | 4;
+}
+export interface SliderFieldProperties {
+    min?: number;
+    max?: number;
+    step?: number;
+    showValue?: boolean;
+    marks?: {
+        value: number;
+        label: string;
+    }[];
+}
+export interface RatingFieldProperties {
+    max?: number;
+    allowHalf?: boolean;
+    icon?: 'star' | 'heart' | 'circle';
+    showValue?: boolean;
+}
+export interface ToggleFieldProperties {
+    /** Text value to submit when toggle is ON */
+    onValue?: string;
+    /** Text value to submit when toggle is OFF */
+    offValue?: string;
+    /** Display text shown on UI when toggle is ON */
+    onText?: string;
+    /** Display text shown on UI when toggle is OFF */
+    offText?: string;
+}
+/** Position of section heading inside the grid box (3x3 grid) */
+export type SectionHeadingPosition = 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+export type SectionHeadingLevel = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+export interface SectionHeadingProperties {
+    /** Position of heading inside the grid box */
+    position?: SectionHeadingPosition;
+    /** Heading size (h1–h6) */
+    headingLevel?: SectionHeadingLevel;
+    /** Show horizontal line below the heading (default true) */
+    showHorizontalLine?: boolean;
+    /** Root field names grouped under this UI section (for Customize sections visibility) */
+    linkedFieldNames?: string[];
+}
+export interface HeaderProperties {
+    /** Heading size (h1–h6) */
+    headingLevel?: SectionHeadingLevel;
+    /** Show horizontal line below the heading (default true) */
+    showHorizontalLine?: boolean;
+}
+/** One status item: label shown in list, key used to read boolean from data (e.g. response.data.registered) */
+export interface StatusItem {
+    label: string;
+    key: string;
+}
+export interface StatusFieldProperties {
+    /** 'manual' = use value from form/prepopulate; 'api' = fetch from status API */
+    source?: 'manual' | 'api';
+    /** List of statuses to show (label + key for lookup in data) */
+    statuses?: StatusItem[];
+    /** When source is 'api': endpoint URL (supports {ctx:key}, URL params) */
+    apiEndpoint?: string;
+    /** When source is 'api': HTTP method */
+    apiMethod?: 'GET' | 'POST';
+    /** Path to the object containing status booleans (e.g. "data" for response.data) */
+    dataPath?: string;
+    /** Show the raw status text from API (e.g. admissionStatus: "DOCUMENTS_VERIFIED") */
+    showStatusText?: boolean;
+    /** Path to the status text in response (e.g. "data.admissionStatus") */
+    statusTextPath?: string;
+    /** Show "Current" badge on the first completed (true) status */
+    showCurrentIndicator?: boolean;
+}
+export interface ButtonFieldProperties {
+    variant?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link';
+    size?: 'default' | 'sm' | 'lg' | 'icon';
+    action?: 'submit' | 'reset' | 'cancel' | 'download' | 'upload' | 'custom' | 'saveAndNext' | 'next' | 'prev' | 'openWorkflowModal' | 'openFormModal' | 'gotoStep';
+    submitAction?: 'database' | 'api' | 'custom';
+    apiEndpoint?: string;
+    submitApiMethod?: 'GET' | 'POST' | 'PUT' | 'PATCH';
+    valueSourceApiEndpoint?: string;
+    valueSource?: 'static' | 'calculated' | 'conditional' | 'api' | 'database';
+    apiBodyStructure?: 'nested' | 'flat';
+    /** When true, send only selected sections/root fields and/or custom body fields (not the full form). */
+    apiBodyFieldsOnly?: boolean;
+    /** Body format to use when apiBodyFieldsOnly is true. */
+    apiBodyFieldsOnlyFormat?: 'json' | 'multipart';
+    /** Form section ids to include when apiBodyFieldsOnly is true (nested by section payloadKey). */
+    submitPayloadSectionIds?: string[];
+    /** Root-level form field names to include when apiBodyFieldsOnly is true. */
+    submitPayloadRootFields?: string[];
+    apiFieldTypes?: Record<string, 'string' | 'number' | 'boolean' | 'date'>;
+    apiFieldMapping?: Record<string, string>;
+    apiQueryParams?: Array<{
+        key: string;
+        value: string;
+    }>;
+    apiBodyFields?: Array<{
+        key: string;
+        value: string;
+    }>;
+    apiHeaders?: Array<{
+        key: string;
+        value: string;
+    }>;
+    /** Structured API authentication (Bearer, API key header, Basic). */
+    apiAuth?: SelectFieldProperties['apiAuth'];
+    downloadApiEndpoint?: string;
+    downloadApiMethod?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    uploadAction?: 'database' | 'api' | 'custom';
+    uploadApiEndpoint?: string;
+    uploadApiMethod?: 'GET' | 'POST' | 'PUT' | 'PATCH';
+    closeOnCancel?: boolean;
+    hideLabel?: boolean;
+    buttonText?: string;
+    onClick?: string;
+    /** openWorkflowModal: child workflow to run inside modal */
+    workflowId?: string;
+    entryStepId?: string;
+    modalTitle?: string;
+    /** Field names from parent form to pass into modal context */
+    passFields?: string[];
+    /** openFormModal: standalone form definition id */
+    formDefinitionId?: string;
+    /** gotoStep: target step id within current or modal workflow */
+    targetStepId?: string;
+    /**
+     * When true, after a successful API response with `data.id`, merge that id into `{ctx:payment_id}` context
+     * even if the body has no payment markers (use for minimal Pay create responses).
+     */
+    mergeSuccessDataIdAsPaymentId?: boolean;
+    /**
+     * Save & Next: map API response to form fields / context before next page.
+     * Toast message always comes from the API response body.
+     */
+    apiSuccessConfig?: ButtonApiSuccessConfig;
+}
+/** Response mapping for Save & Next after successful API call. */
+export interface ButtonApiSuccessConfig {
+    /** Form field name → dot path in API response (e.g. abha_accounts → accounts). */
+    fieldMapping?: Record<string, string>;
+    /** Context key → dot path in API response for {ctx:key} on later steps (e.g. txnId → txnId). */
+    contextMapping?: Record<string, string>;
+}
+export interface AddMoreFieldProperties {
+    /** Field names that should be duplicated as a block when clicked */
+    linkedFieldNames?: string[];
+    /** Section ids from config.sections — union fieldNames with linkedFieldNames (deduped) */
+    linkedSectionIds?: string[];
+    /**
+     * Per linked field: allow the same value to be selected/entered in other add-more blocks.
+     * Key = linked field name, value = true (allow duplicates, default) | false (prevent duplicates across blocks).
+     */
+    linkedFieldAllowDuplicate?: Record<string, boolean>;
+    /** Optional button style to align with button component variants */
+    variant?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link';
+    /** Optional button size to align with button component sizes */
+    size?: 'default' | 'sm' | 'lg' | 'icon';
+    /** Optional custom text for the add more trigger */
+    buttonText?: string;
+    /** Hide the field label above the add more button */
+    hideLabel?: boolean;
+}
+export interface CustomizeSectionsFieldProperties {
+    /** Section heading field names to list in the menu; empty = all root section headings */
+    sectionHeadingNames?: string[];
+    /** Section heading field names hidden on initial load */
+    defaultHiddenSectionNames?: string[];
+    variant?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link';
+    size?: 'default' | 'sm' | 'lg' | 'icon';
+    buttonText?: string;
+    menuTitle?: string;
+    hideLabel?: boolean;
+}
+/** Target selection for an Edit Button rule (stored so "Choose fields" / "Choose buttons" with none selected still shows the right UI). */
+export type EditButtonRuleTargetKind = 'allFields' | 'allButtons' | 'chooseFields' | 'chooseButtons';
+/** One rule for Edit Button: when clicked, apply this action to the selected targets. */
+export interface EditButtonRule {
+    id: string;
+    /** enable = not disabled (clickable); disable = gray out; show/hide = visibility; readOnly = read-only; editable = make editable (overrides schema readOnly) */
+    action: 'enable' | 'disable' | 'show' | 'hide' | 'readOnly' | 'editable';
+    /** Which target mode the user chose (so "Choose fields" with no selection yet still shows the fields list). */
+    targetKind?: EditButtonRuleTargetKind;
+    /** Apply to all form fields (excluding this edit button) */
+    allFields?: boolean;
+    /** Apply to all button-type fields */
+    allButtons?: boolean;
+    /** Apply to these field names (when targetKind is chooseFields) */
+    fieldNames?: string[];
+    /** Apply to these button field names (when targetKind is chooseButtons) */
+    buttonNames?: string[];
+}
+/** Edit Button: no API; on click toggles "edit mode". Config is a list of rules (action + targets). */
+export interface EditButtonFieldProperties {
+    variant?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link';
+    size?: 'default' | 'sm' | 'lg' | 'icon';
+    /** Button label (e.g. "Edit") */
+    buttonText?: string;
+    /** Hide the field label above the button */
+    hideLabel?: boolean;
+    /** Rules applied when this edit button is clicked. Each rule: action + allFields / allButtons / fieldNames / buttonNames. */
+    rules?: EditButtonRule[];
+    /** @deprecated Use rules. Kept for backward compatibility. */
+    enableFieldNames?: string[];
+    /** @deprecated Use rules. */
+    disableFieldNames?: string[];
+    /** @deprecated Use rules. */
+    showFieldNames?: string[];
+    /** @deprecated Use rules. */
+    hideFieldNames?: string[];
+}
+export declare function isTextFieldProperties(props: unknown): props is TextFieldProperties;
+export declare function isNumberFieldProperties(props: unknown): props is NumberFieldProperties;
+export declare function isSelectFieldProperties(props: unknown): props is SelectFieldProperties;
+export declare function isAsyncSearchFieldProperties(props: unknown): props is AsyncSearchFieldProperties;
+export declare function isDateFieldProperties(props: unknown): props is DateFieldProperties;
+export declare function isFileFieldProperties(props: unknown): props is FileFieldProperties;
+export declare function isTableFieldProperties(props: unknown): props is TableFieldProperties;
+export declare function isBillingGridFieldProperties(props: unknown): props is BillingGridFieldProperties;
+export declare function isSectionProperties(props: unknown): props is SectionProperties;
+export declare function isToggleFieldProperties(props: unknown): props is ToggleFieldProperties;
+export declare function isSectionHeadingProperties(props: unknown): props is SectionHeadingProperties;
+export declare function isTextLabelFieldProperties(props: unknown): props is TextLabelFieldProperties;
+export declare function isContainerField(type: FieldType): boolean;
+export declare function isVisualLayoutField(type: FieldType): boolean;
+export declare function isLayoutField(type: FieldType): boolean;
+export declare function isInputField(type: FieldType): boolean;
+//# sourceMappingURL=field.d.ts.map