# Flexi Form Removal and Revamp - Consumer Application Pages

Branch: `flexi-form-removal-and-revamp`

---

## Overview

The consumer application add, lead-add and edit pages used a "flexi form". On each page load, `public/js/en.js` fetched a JSON config from the `page_config` table, built form fields in the browser and inserted them into the page. The edit page also filled their values from `POST /api/get-application-data`.

This revamp removes that dependency. All fields the flexi form rendered are now plain Blade markup in `edit_v1.blade.php`, prefilled on the server. The config editor in the admin header is removed, and the flexi-only routes are commented out. Saving needed no PHP change, because `store()` and `getEditPostConsumerApplication()` already saved these fields from the normal form submit. The edit page's read-only rule, field locking and new pincode/mobile checks are now in the blade's JS.

### Pages affected

All three pages render the same blade, `resources/views/admin/consumer-application/edit_v1.blade.php`.

| Page | Controller method (GET) | `$page_type` |
|---|---|---|
| `admin/consumer-applications/add` | `ConsumerApplicationController@create` | `'create'` |
| `admin/consumer-applications/lead-add` | `ConsumerApplicationController@createConsumerLead` | `'lead'` |
| `admin/consumer-applications/edit/{application_id}` | `ConsumerApplicationController@edit` | not set |

The list page `admin/consumer-applications` also had a `page_config` row, but with `fields: []`, so the flexi form never rendered anything there.

---

## Fields moved to Blade (27)

Each field is placed where the flexi form inserted it: right after the same anchor element. Element ids, wrapper ids, names, classes, placeholders, `minlength`/`maxlength`, `onkeyup` filters and `data-required` were copied from the edit page config.

Values are `Request::old('<name>', <stored column> ?? '')`. Dropdown option lists are PHP arrays in `@php` blocks, so each list exists once. A dropdown only pre-selects an option that exactly matches the stored value; if the stored value isn't in the list, the select shows empty (same as before). Every one of these inputs/selects has the class `post-approval-unlocked` (see "Field locking" below).

### Applicant Details

| Field | `name` | Saved to | Placed after | Notes |
|---|---|---|---|---|
| Preferred Language | `preferred_language` | `consumer_application_element.preferred_language` | `#lender_id_attr` | Inside the hidden `#languageSelection` block toggled by the "Update - Preferred language" link. Required. ENGLISH pre-selected on add and lead-add when nothing is stored; empty on edit when nothing is stored. |
| Father Name | `father_name` | `consumer_application_element.father_name` | `#customer_name_attr` | Required. Letters and spaces only (`onkeyup`). |
| Mother Name | `mother_name` | `consumer_application_element.mother_name` | `#father_name_attr_div` | Not required. The red `*` that the flexi form showed is removed. |
| Alternate Mobile | `alt_contact_number` | `consumer_application.alt_contact_number` | `#phone_number_view` | Digits only, max 10. |
| Email | `email` | `consumer_application.email` | `#alternate_mobile_attr_div` | Required. After Alternate Mobile on all pages (lead-add used to place it after Mother Name). |
| Education Level | `education_level` | `consumer_application_element.education_level` | `#monthly_income` | 10th Grade, 12th Grade, Graduation, Post graduation, Masters |
| Caste | `applicant_caste` | `consumer_application_element.applicant_caste` | `#education_level_attr` | Schedule Tribe, General, Minority, Schedule Caste, Other Backward Class, Others |
| Religion | `applicant_religion` | `consumer_application_element.applicant_religion` | `#caste_attr` | Required on all pages. HINDU, MUSLIM, CHRISTIAN, SIKHS, SIKH, JAINS, JAIN, ZOROASTRIANS, BUDDHIST, PARSI, BHAHAI, Others (the edit/add list; lead-add's shorter list is gone). |
| Loan Type | `loan_type` | `consumer_application_element.loan_type` | `#religion_box_attr` | Fresh, BT |
| Unique ID Number | `unique_id_number` | `consumer_application_element.unique_id_number` | `#merchant_name` | Inside the hidden `#uniqueIDForm` block toggled by the "Unique ID Number" link. |
| Video KYC | `video_kyc` | `consumer_application_element.video_kyc` | `#video_kyc_selection_attr` | |

### Merchant Representative Details

| Field | `name` | Saved to | Placed after | Notes |
|---|---|---|---|---|
| Name | `merchant_representative_name` | `consumer_application_element.merchant_representative_name` | `#representative_name_selection_attr` | |
| Mobile | `merchant_representative_mobile` | `consumer_application_element.merchant_representative_mobile` | `#representative_mobile_selection_attr` | Digits only, max 10. |
| Email | `merchant_representative_email` | `consumer_application_element.merchant_representative_email` | `#representative_email_selection_attr` | |

### Employment Details

| Field | `name` | Saved to | Placed after | Notes |
|---|---|---|---|---|
| Profession | `employee_status` | `consumer_application.employee_status` | `#profession_attr` | UNEMPLOYED, SALARIED, BUSINESS, Self Employed - Business, Self Employed - Professional, PENSIONER, HOUSEWIFE |

### Applicant Address and Solar Installation Address Details

City, Landmark and Pincode go after the address lines row (`#applicant_<type>_address_div`). Status goes after the State row (`#applicant_<type>_address_state`). Element ids are unchanged (for example `#permanent_address_city`), because the existing address JS (the "same as" checkboxes, autofill, address-change comparison) selects them by id.

| Field | `name` | Saved to |
|---|---|---|
| Permanent Address City / Landmark / Pincode / Status | `permanent_address_city`, `permanent_address_landmark`, `permanent_address_pincode`, `permanent_address_status` | `consumer_application` |
| Current Address City / Landmark / Pincode / Status | `current_address_city`, `current_address_landmark`, `current_address_pincode`, `current_address_status` | `consumer_application` |
| Installation Address City / Landmark / Pincode / Status | `installation_address_city`, `installation_address_landmark`, `installation_address_pincode`, `installation_address_status` | `consumer_application_element` |

Status options (shared by all three): RENTED, OWNED, PARENTS HOUSE, Self Owned, Parent Owned, Rented With Family, Rented With Friend, Company Allotted. Pincodes accept digits only, max 6.

---

## Flexi fields discarded (not moved to Blade)

| Field(s) | Was on | Reason |
|---|---|---|
| `lender` (select), `pan_no` (input), `gender` (radio) | all three | `show: false` in every config, so the flexi form never rendered them. |
| `loan_applied_for`, `loan_applied_for_mobile`, `loan_applied_for_relation` | all three | Never saved: not in `ConsumerApplicationElement::$fillable` and not assigned anywhere in PHP. Their row only rendered inside `@if(application_element->loan_applied_for)`, which could never be true. The static "Additional Details" block holding them was deleted too. |
| `panel` (flexi copy, Panel to be Installed) | edit (when purpose = 6), lead-add | Duplicate of the static `panel` select in the Solar & Panel tab. PHP keeps the last value for a repeated name, so the static select (rendered later on the page) was always the one saved. The static select and its option list (`ConsumerApplicationController::panelList()`) are unchanged. See "Known differences" for the options this drops. |
| `approved_amount`, `designation`, `department`, `contact`, `company_number`, `profession` (Company Type), `experience` (flexi copies) | lead-add | Duplicates of static fields already in the blade. Only the static copies remain. On master the flexi copy was the one saved for `company_number`, `profession` and `experience`, because it came later on the page; now the static copy is saved. |

---

## Other changes

### Flexi rendering removed
- `footer.blade.php`: removed the `$(document).ready` block that called `get_json_page_config()`, `parseJSONToForm()` and `_mm_txr()`. Masking still works for the new static fields because `masking.js` runs `_mm_txr()` on load.

### Edit page read-only rule (ported from the config's `after_execution`)
- New `<script>` block at the end of `edit_v1.blade.php`, inside `@if(!isset($page_type))`, so it runs on edit only.
- Ported as-is. When the state is approved, disbursement checklist done, disbursement query, ready for disbursement, disbursed, cancelled or cancellation in-process, and `#app-status-current` has `edit-access == 0`, it makes every filled input and select `readonly` with `disable-view`. It then removes `readonly`/`disable-view` from every checkbox.
- Runs on `$(window).on('load')` so it comes after every ready handler, which is the order it had when it ran after the flexi AJAX calls.
- Kept in its own block because it throws when `#app-status-current` isn't rendered (merchant_v2 users). That gap is kept as it was: the rule does nothing for those users.

### Field locking
- `enableFields()` (edit page, post-approval lock for users without `Post_Approval_Edit|-19`) locks every input and select. A line now removes `disable-view` from `.post-approval-unlocked` right after, so the 27 fields stay out of that blanket lock, as they were when flexi created them later.
- The closed / nach registered branch (`$disable_edits === 2`) is unchanged and locks all fields, including the 27 and Video KYC.

| State | User | The 27 fields |
|---|---|---|
| Up to waiting for decision, pre approved, cf approved, rejected, aborted | anyone | editable |
| approved, disbursement checklist done, disbursement query, ready for disbursement, cancelled, cancellation in-process | without `Post_Approval_Edit` | filled ones locked, empty ones editable |
| same | with `Post_Approval_Edit` | editable |
| disbursed | anyone | filled ones locked, empty ones editable |
| query resolved, settlement states | anyone | editable (not in the read-only rule's state list, same as before) |
| closed, nach registered | anyone | all locked |

### New client-side checks
In the form submit handler, right after `validateForm(form)`, on add, lead-add and edit. Each check only runs when the field has a value. On failure it opens the field's tab and collapsed panel, focuses the field, shows a snackbar message, re-enables Save/Submit and stops the submit.

| Field | Rule |
|---|---|
| `permanent_address_pincode`, `current_address_pincode`, `installation_address_pincode` | exactly 6 digits |
| `alt_contact_number`, `merchant_representative_mobile` | exactly 10 digits |

The flexi form's regex border colouring was dropped. No server-side validation was added.

### Config editor and endpoints removed
- `header.blade.php`: removed the `/js/en.js` script tag, `CF_JSON_PAGE_CONFIG = null`, the JSON config modal (`#bd-config-modal-lg`) and its CSS, and the top-bar config icon shown for `Page_JSON_Config|-65`.
- `footer.blade.php`: removed the icon click handler, `validateJson()`, `highlightLines()`, `getJsonErrorLine()`, `get_json_page_config()` and the save-config handler. `escapeHtml()` is kept because `sections/deviations.blade.php` uses it.
- Routes commented out:
  - `routes/admin.php`: `POST admin/config/get-config`, `POST admin/config/save-config`
  - `routes/api.php`: `POST api/get-lenders`, `POST api/get-application-data`

### Cleanup in `edit_v1.blade.php`
Old commented-out copies of the moved fields were deleted, so each field exists once: Education/Caste/Religion, both Unique ID copies, Video KYC, Merchant Representative, Profession and all three address groups.

### Kept in place (not removed)
- `public/js/en.js` (no longer loaded).
- `ConsumerApplicationController::getPageConfig()` / `savePageConfig()` and `ApiController::getLenderData()` / `getApplicationData()` / `getTableMapping()` (their routes are commented out).
- The `page_config` table, `App\PageConfig` and the `Page_JSON_Config|-65` permission.
- `view()->share('page_path_config', ...)` in `app/Http/Middleware/AuthenticateAdmin.php`. Nothing reads it any more.

---

## Known differences from master

- **Panel options:** the dropped flexi `panel` list had 18 options that `panelList()` doesn't have: Vaibhav Test, vikram solar, goldi solar pvt. ltd, saatvik green energy, servotech power systems ltd, emmvee photovoltaic power private limited, bluebird solar, swelect energy systems, insolation energy, renewable energy corporation, bamani solar solutions |utl solar shoppe, aadhi solar, sungrow, vsole solar, deye, ksolare, feston, solis. They can't be picked any more. An application that already has one stored shows "Other" with the name in the "Other panel" box, and saving stores it in uppercase (this also happened on master).
- **Labels:** Preferred Language, Father Name, Email and Religion have a space before the red `*` (`Field: *` instead of `Field:*`).
- **Preferred Language default:** ENGLISH on add and lead-add when empty (add's flexi placeholder used to submit ENGLISH; lead-add set it by script).
- **lead-add:** Religion is now required with the full list, and Email sits after Alternate Mobile.
- **Old input:** the 27 fields now keep `Request::old()` values after a redirect. Flexi fields never did.
- **merchant_v2 error:** the read-only rule's error used to be swallowed by en.js and logged as "Error fetching data". It now shows as an uncaught `TypeError` in the console, with no other effect.

---

## Files impacted

| File | Change |
|---|---|
| `resources/views/admin/consumer-application/edit_v1.blade.php` | 27 fields added in Blade, old commented copies and the Additional Details block removed, `post-approval-unlocked` exclusion in `enableFields()`, pincode/mobile checks in the submit handler, ported read-only rule. |
| `resources/views/admin/layouts/footer.blade.php` | Flexi load call and config editor JS removed. |
| `resources/views/admin/layouts/header.blade.php` | `en.js` tag, `CF_JSON_PAGE_CONFIG`, config modal and its CSS, and the config icon removed. |
| `routes/admin.php` | `config/get-config` and `config/save-config` commented out. |
| `routes/api.php` | `get-lenders` and `get-application-data` commented out. |

Supporting material (not application code) is in `documentation/page_config/`:
- `flexi_fields.md`: field list per page as rendered by the flexi form.
- `flexi_removal_plan.md`: the step-by-step plan, with reference markup.
- `baseline/`: `capture.js`, `compare.py`, README and the edit page captures.
- The decoded `page_config` exports.

### Commits on the branch
| Commit | Step |
|---|---|
| `b50651c881` | Stop rendering the flexi form (footer call removed) |
| `e92e20bf92` | Applicant Details fields |
| `2f415349b3` | Address fields |
| `bd9ee50181` | Merchant Representative fields, Additional Details removed |
| `59b7378d79` | Profession field, locking exclusion and ported read-only rule |
| `0624d8fa0b` | Pincode and mobile checks |
| `796f2c4996` | Config editor, en.js tag and flexi routes removed |