(fix)O3-1144: Remove redundant type definitions, use types from form-engine #998

RajPrakash681 · 2025-10-29T22:00:39Z

Requirements

This PR has a title that briefly describes the work done including the ticket number. If there is a ticket, make sure your PR title includes a conventional commit label. See existing PR titles for inspiration.
My work conforms to the OpenMRS 3.0 Styleguide and design documentation.
My work includes tests or is validated by existing tests.

Summary

This PR removes redundant type definitions from the form builder and uses types directly from @openmrs/esm-form-engine-lib.

Changes made:

Removed local type definitions for Schema, Page, Section, Question, and QuestionOptions
Updated all imports across the codebase to use types directly from @openmrs/esm-form-engine-lib
Created FormBuilderSchema interface that extends FormSchema to include the description property, which is specific to the form builder's needs
Updated src/types.ts to export FormBuilderSchema as Schema for backward compatibility

Screenshots

N/A - No UI changes

Related Issue

https://issues.openmrs.org/browse/O3-1144

Other

None

…e-lib - Import and re-export types (FormField, FormPage, FormSection, FormQuestionOptions, etc.) from @openmrs/esm-form-engine-lib instead of defining them locally - Create type aliases (Page, Section, Question, QuestionOptions) pointing to form-engine types for backward compatibility - Export additional useful types (QuestionAnswerOption, HideProps, DisableProps, RepeatOptions, etc.) from form-engine-lib - Update add-form-reference.modal.tsx to use FormPage, FormSection, FormField instead of local Page, Section, Question types - All tests passing, no breaking changes

RajPrakash681 · 2025-10-30T06:34:07Z

@NethmiRodrigo just got drained out in this issue...please let me know if these changes works

NethmiRodrigo

Thanks @RajPrakash681

src/components/interactive-builder/modals/add-form-reference/add-form-reference.modal.tsx

NethmiRodrigo · 2025-10-31T10:03:01Z

src/types.ts

-  translations?: Record<string, string>;
-}
+// Using extended FormBuilderSchema instead of FormSchema
+export type Schema = FormBuilderSchema;


We should just directly import all types from the form-engine-lib itself and remove them from this file, we shouldn't need to export from here. Even though that would mean that we need to update a lot of files, it just seems redundant to export them from here again

We should just directly import all types from the form-engine-lib itself and remove them from this file, we shouldn't need to export from here. Even though that would mean that we need to update a lot of files, it just seems redundant to export them from here again

You're absolutely right! Re-exporting these types is redundant. I'll update the codebase to import types directly from @openmrs/openmrs-form-engine-lib where they're used, rather than going through this intermediary file. This will make the dependencies clearer and reduce unnecessary abstraction.

Why are we still re-exporting the schema from here? If it’s because the type from form-engine-lib is missing the description property, it’s highly possible that it's a mistake. Could you ask this in the #form-engine channel on Slack, and fix it in the form engine?

- Remove re-exported types from src/types.ts - Update all files to import FormField, FormPage, FormSection directly from @openmrs/esm-form-engine-lib - Keep only local types in src/types.ts (FormBuilderSchema, Form, Schema, Concept, etc.) - This eliminates redundant type re-exports and makes dependencies clearer

RajPrakash681 · 2025-11-02T10:08:23Z

@NethmiRodrigo good morning ma'am any updates about it..?

dkayiwa · 2025-11-02T21:51:08Z

ma'am

oh woow!!! 😊

RajPrakash681 · 2025-11-06T07:15:35Z

@NethmiRodrigo i think this issue's requirement is fulfilled please have a look and tell what more changes it needs!!

RajPrakash681 · 2025-11-10T08:33:09Z

@NethmiRodrigo this one also

NethmiRodrigo · 2025-11-10T13:53:24Z

src/types.ts

-  translations?: Record<string, string>;
-}
+// Using extended FormBuilderSchema instead of FormSchema
+export type Schema = FormBuilderSchema;


Why are we still re-exporting the schema from here? If it’s because the type from form-engine-lib is missing the description property, it’s highly possible that it's a mistake. Could you ask this in the #form-engine channel on Slack, and fix it in the form engine?

NethmiRodrigo · 2025-11-10T13:54:06Z

translations/en.json

Can you please undo the changes to this file? And change your end of line as was mentioned in one of your other PRs in a different repo?

NethmiRodrigo · 2025-11-10T13:58:40Z

Also, I believe I’ve mentioned this before, please don’t change the PR template. Whenever you create a new PR, there will be a template, which you can fill out. Please stick to that and do not change it. AI tends to change it all the time, so make sure that you double check and change it back, this applies to all repositories, except where there isn’t a template.

RajPrakash681 · 2025-11-10T14:23:55Z

Also, I believe I’ve mentioned this before, please don’t change the PR template. Whenever you create a new PR, there will be a template, which you can fill out. Please stick to that and do not change it. AI tends to change it all the time, so make sure that you double check and change it back, this applies to all repositories, except where there isn’t a template.

Thanks for pointing that out, Nethmi. Usually, I fill out the PR template manually after you guided me about it earlier, but I missed it this time since I was in a bit of a hurry. Sorry about that I’ll make sure to double-check and stick to the template in all future PRs

… EOL to LF

RajPrakash681 · 2025-11-10T15:48:40Z

Why are we still re-exporting the schema from here? If it’s because the type from form-engine-lib is missing the description property, it’s highly possible that it's a mistake. Could you ask this in the #form-engine channel on Slack, and fix it in the form engine?

I'll ask about this in the #form-engine Slack channel and make the necessary changes based on their guidance. Will update you once I hear back.

RajPrakash681 · 2025-11-11T15:06:22Z

Why are we still re-exporting the schema from here? If it’s because the type from form-engine-lib is missing the description property, it’s highly possible that it's a mistake. Could you ask this in the #form-engine channel on Slack, and fix it in the form engine?

I'll ask about this in the #form-engine Slack channel and make the necessary changes based on their guidance. Will update you once I hear back.

The real question is whether or not the form-engine-lib needs to know about the description property on the FormSchema and I'm not entirely certain what it would do with that information. Thus, the thing the form-builder (which does use the description) is doing is probably right for now.

this is what ian said me when i asked him about this!

RajPrakash681 · 2025-11-17T12:21:24Z

@NethmiRodrigo hello, hope you would be doing well ! what should i do now in this.. any update ?

NethmiRodrigo

One minor nit

src/components/interactive-builder/modals/add-form-reference/add-form-reference.modal.tsx

…dd-form-reference.modal.tsx Co-authored-by: Nethmi Rodrigo <[email protected]>

RajPrakash681 · 2025-11-20T11:28:01Z

One minor nit

Done!

RajPrakash681 · 2025-12-01T08:41:13Z

@NethmiRodrigo Hi, can this be merged now or does this require more things to fix!?

NethmiRodrigo reviewed Oct 31, 2025

View reviewed changes

RajPrakash681 force-pushed the types-refactor-clean branch from 239de4d to ab20c96 Compare October 31, 2025 10:48

RajPrakash681 requested a review from NethmiRodrigo November 10, 2025 08:13

NethmiRodrigo reviewed Nov 10, 2025

View reviewed changes

fix: Revert translations/en.json to match upstream/main and normalize…

d0be6e2

… EOL to LF

RajPrakash681 force-pushed the types-refactor-clean branch from 2ec0f43 to d0be6e2 Compare November 10, 2025 15:42

Merge branch 'main' into types-refactor-clean

abdba26

NethmiRodrigo approved these changes Nov 20, 2025

View reviewed changes

src/components/interactive-builder/modals/add-form-reference/add-form-reference.modal.tsx Outdated Show resolved Hide resolved

Update src/components/interactive-builder/modals/add-form-reference/a…

caa48c7

…dd-form-reference.modal.tsx Co-authored-by: Nethmi Rodrigo <[email protected]>

Merge branch 'main' into types-refactor-clean

ae920a3

(fix)O3-1144: Remove redundant type definitions, use types from form-engine #998

Are you sure you want to change the base?

(fix)O3-1144: Remove redundant type definitions, use types from form-engine #998

Uh oh!

Conversation

RajPrakash681 commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Requirements

Summary

Screenshots

Related Issue

Other

Uh oh!

RajPrakash681 commented Oct 30, 2025

Uh oh!

NethmiRodrigo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NethmiRodrigo Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

RajPrakash681 Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

NethmiRodrigo Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

RajPrakash681 commented Nov 2, 2025

Uh oh!

dkayiwa commented Nov 2, 2025

Uh oh!

RajPrakash681 commented Nov 6, 2025

Uh oh!

RajPrakash681 commented Nov 10, 2025

Uh oh!

NethmiRodrigo Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

NethmiRodrigo Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

NethmiRodrigo commented Nov 10, 2025

Uh oh!

RajPrakash681 commented Nov 10, 2025

Uh oh!

RajPrakash681 commented Nov 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RajPrakash681 commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RajPrakash681 commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NethmiRodrigo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

RajPrakash681 commented Nov 20, 2025

Uh oh!

RajPrakash681 commented Dec 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

RajPrakash681 commented Oct 29, 2025 •

edited

Loading

RajPrakash681 commented Nov 10, 2025 •

edited

Loading

RajPrakash681 commented Nov 11, 2025 •

edited

Loading

RajPrakash681 commented Nov 17, 2025 •

edited

Loading