How sap/open-ux-tools works
Open UX Tools is a monorepo of reusable modules for SAP Fiori application development, including scaffolding and configuration, runtime adaptation, cloud/ABAP tooling, and annotation processing. A representative user workflow is adapting a running application: the preview client gathers fragment data, prepares a UI5 change command, executes it through runtime authoring, and can request an application reload. The README identifies Fiori generator and easyUI5 as consumers. Most package internals were not sampled, so their capabilities are shown without speculative call links.
Main entry points: api-handler.ts Fragment API · command-executor.ts Command executor · AddFragment.controller.ts Fragment dialog · AddCustomFragment.controller.ts Custom fragment dialog
Components 25
Scaffolding and config
- ABAP deploy prompts
packages/abap-deploy-config-inquirer/src - ABAP deploy generator
packages/abap-deploy-config-sub-generator/src - ABAP config writer
packages/abap-deploy-config-writer/src - Cloud deploy prompts
packages/cf-deploy-config-inquirer/src - Cloud deploy generator
packages/cf-deploy-config-sub-generator/src - Cloud config writer
packages/cf-deploy-config-writer/src - App config writer
packages/app-config-writer/src - CAP config writer
packages/cap-config-writer/src - Freestyle templates
packages/fiori-freestyle-writer/templates
UI5 authoring
- Preview client
packages/preview-middleware-client/src/adp/controllers - Fragment dialog
packages/preview-middleware-client/src/adp/controllers/AddFragment.controller.ts - Custom fragment dialog
packages/preview-middleware-client/src/adp/controllers/AddCustomFragment.controller.ts - Table fragment dialog
packages/preview-middleware-client/src/adp/controllers/AddTableColumnFragments.controller.ts - Fragment API
packages/preview-middleware-client/src/adp/api-handler.ts - Command executor
packages/preview-middleware-client/src/adp/command-executor.ts - ADP tooling
packages/adp-tooling/src
Platform integration
- Cloud proxy middleware
packages/backend-proxy-middleware-cf/src - Proxy middleware
packages/backend-proxy-middleware/src - HTTP and ABAP services
packages/axios-extension/src - BTP utilities
packages/btp-utils/src
Annotation processing
- Annotation generator
packages/annotation-generator/src - CDS annotation parser
packages/cds-annotation-parser/src - Annotation converter
packages/cds-odata-annotation-converter/src
Other components
- Fiori generator
- easyUI5
Connections 8
- Fiori generator → ABAP deploy generator: consumes modules
- easyUI5 → ABAP deploy generator: consumes modules
- Fragment dialog → Fragment API: fetches fragments
- Custom fragment dialog → Fragment API: fetches fragments
- Table fragment dialog → Fragment API: fetches fragments
- Fragment dialog → Command executor: creates change
- Custom fragment dialog → Command executor: creates change
- Table fragment dialog → Command executor: executes change