@openmrs/esm-form-entry-app 12.3.5-pre.11707 → 12.3.5-pre.11712

package/.turbo/turbo-build.log

@@ -65,7 +65,7 @@ opera 131, opera 127, opera 126
 890.aed0da1bd90649d7.js                             | -                           |   2.75 kB |               975 bytes
 9895.cfb49e32de686175.js                            | -                           |   2.75 kB |               973 bytes
 
-Build at: 2026-07-17T12:56:42.060Z - Hash: 6ba79e850bf4a888 - Time: 207353ms
+Build at: 2026-07-17T22:06:24.653Z - Hash: 6ba79e850bf4a888 - Time: 231567ms
 
 Warning: /home/runner/work/openmrs-esm-patient-chart/openmrs-esm-patient-chart/node_modules/@carbon/react/es/components/Accordion/Accordion.js depends on 'prop-types'. CommonJS or AMD dependencies can cause optimization bailouts.
 For more info see: https://angular.dev/tools/cli/build#configuring-commonjs-dependencies

package/README.md

@@ -1,7 +1,119 @@
-# esm-form-entry-app
+# @openmrs/esm-form-entry-app
 
-This widget encapsulates the form entry capabilities of the AMPATH form engine. It's essentially a wrapper around an Angular application that renders JSON schemas built using the AMPATH form engine as HTML forms. The user can fill and submit forms and receive success or error notifications upon submission. Read the docs [here](https://ampath-forms.vercel.app).
+`esm-form-entry-app` is an O3 patient chart widget that loads clinical forms
+defined using the
+[O3 form schema](https://github.com/openmrs/openmrs-contrib-json-schemas/blob/main/form.schema.json),
+renders and processes them with the
+[Angular Form Engine (`@openmrs/ngx-formentry`)](https://github.com/openmrs/openmrs-ngx-formentry),
+and submits the resulting data to OpenMRS.
+
+## Status and availability
+
+The O3 Reference Application ships the
+[React Form Engine (`@openmrs/esm-form-engine-lib`)](https://github.com/openmrs/openmrs-esm-form-engine-lib)
+by default through `@openmrs/esm-form-engine-app`.
+
+This Angular-based form entry app is retained for implementations that still
+depend on the Angular Form Engine and have not yet migrated to the React Form
+Engine. It is not included in the
+[default Reference Application SPA assembly](https://github.com/openmrs/openmrs-distro-referenceapplication/blob/main/frontend/spa-assemble-config.json).
+
+Implementations using this app must include `@openmrs/esm-form-entry-app` in
+their SPA assembly configuration. The Angular and React integrations both
+register a form renderer in `form-widget-slot` and should not be enabled
+together.
+
+In a Reference Application-based distribution, use the Angular integration by
+replacing the React integration in `spa-assemble-config.json`:
+
+```diff
+- "@openmrs/esm-form-engine-app": "next",
++ "@openmrs/esm-form-entry-app": "next",
+```
+
+Use a version or release tag compatible with the rest of the implementation's
+O3 frontend dependencies.
+
+To migrate to the React Form Engine, replace `@openmrs/esm-form-entry-app` with
+`@openmrs/esm-form-engine-app`. See the
+[React Form Engine migration guidance](https://github.com/openmrs/openmrs-esm-form-engine-lib#production).
+
+## Responsibilities
+
+The widget:
+
+- Retrieves an O3 form definition and its associated OpenMRS form metadata.
+- Supplies patient, patient identifier, visit, provider, location, previous
+  encounter, and previous observation data to the form.
+- Renders the form and supports its validation, conditional rendering,
+  calculations, and other form logic.
+- Supports creating new encounters and editing existing encounters.
+- Converts completed forms into OpenMRS payloads, including observations,
+  diagnoses, and orders when specified by the form.
+- Submits encounter data and, when applicable, person attribute and patient
+  identifier updates.
+- Reports loading, validation, and submission results to the surrounding O3
+  workspace.
+
+The fields displayed and payloads produced depend on the form definition.
+
+## How it fits into O3
+
+This package is the O3 integration layer for the Angular Form Engine. It
+connects the engine to the patient chart, OpenMRS REST APIs, patient and visit
+context, workspace lifecycle, configuration, localization, and offline
+framework.
+
+It registers the `form-widget` extension in `form-widget-slot`. The surrounding
+patient form workspace supplies the patient, form UUID, visit, and optional
+encounter context.
+
+This widget handles forms that conform to the O3 form schema. Legacy HTML Form
+Entry forms are handled separately by the patient forms application.
+
+## Form definitions
+
+O3 form definitions are JSON documents that conform to the
+[O3 form schema](https://github.com/openmrs/openmrs-contrib-json-schemas/blob/main/form.schema.json).
+
+This package renders and processes those definitions. It does not provide form
+authoring functionality. Forms can be authored using the
+[O3 Form Builder](https://github.com/openmrs/openmrs-esm-form-builder).
+
+## Backend requirements
+
+The widget requires:
+
+- OpenMRS REST Web Services 2.2.0 or later
+- The O3 Forms backend module
+
+## Development
+
+From this package directory, start the development server with:
+
+```sh
+yarn start
+```
+
+Other useful commands:
+
+```sh
+yarn build
+yarn test
+yarn lint
+```
 
 ## Angular version policy
 
-This app is the Angular part of an otherwise React codebase. It moves together with [openmrs-ngx-formentry](https://github.com/openmrs/openmrs-ngx-formentry) and [openmrs-ngx-file-uploader](https://github.com/openmrs/openmrs-ngx-file-uploader): all three must use the same Angular major version, and that version must still be supported by Angular through the next RefApp release. Before proposing or reviewing an Angular major version bump, read the [Angular version support policy](https://o3-docs.openmrs.org/en-US/docs/frontend-modules/angular-version-policy). It explains when to migrate, how to pick the target version, and which toolchain packages must be ready first.
+This app is the Angular part of an otherwise React codebase. It moves together
+with
+[`openmrs-ngx-formentry`](https://github.com/openmrs/openmrs-ngx-formentry)
+and
+[`openmrs-ngx-file-uploader`](https://github.com/openmrs/openmrs-ngx-file-uploader).
+All three must use the same Angular major version, and that version must remain
+supported by Angular through the next Reference Application release.
+
+Before proposing or reviewing an Angular major version bump, read the
+[Angular version support policy](https://o3-docs.openmrs.org/en-US/docs/frontend-modules/angular-version-policy).
+It explains when to migrate, how to select the target version, and which
+toolchain packages must be ready first.

package/dist/routes.json

@@ -1 +1 @@
-{"$schema":"https://json.openmrs.org/routes.schema.json","backendDependencies":{"webservices.rest":">=2.2.0","o3forms":"*"},"extensions":[{"name":"form-widget","component":"formWidget","slot":"form-widget-slot","online":true,"offline":true}],"version":"12.3.5-pre.11707"}
+{"$schema":"https://json.openmrs.org/routes.schema.json","backendDependencies":{"webservices.rest":">=2.2.0","o3forms":"*"},"extensions":[{"name":"form-widget","component":"formWidget","slot":"form-widget-slot","online":true,"offline":true}],"version":"12.3.5-pre.11712"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-form-entry-app",
-  "version": "12.3.5-pre.11707",
+  "version": "12.3.5-pre.11712",
   "license": "MPL-2.0",
   "description": "Angular form engine for O3",
   "browser": "dist/openmrs-esm-form-entry-app.js",