Registry / web-framework / ui5-middleware-ui5

ui5-middleware-ui5

library3.5.0jsnpmunverified

Middleware for ui5-server (UI5 CLI v3) that allows including and serving UI5 application dependencies within the same server instance. Version 3.5.0 is the latest stable release, actively maintained. It enables embedding UI5 apps as dependencies, configurable via ui5.yaml, and supports mount path customization, module-specific configuration, and debug logging. Requires @ui5/cli >= 3.0.0 with specVersion '3.0'. Community-driven project part of the UI5 ecosystem showcase, distinct from official SAP middlewares.

web-framework

npm install ui5-middleware-ui5

github ↗package ↗

INSTALL

IMPORT

SIG · UI5-MIDDLEWARE-UI5

ui5-middleware-ui5

web-frameworkjavascriptv3.5.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Shows installation and minimal configuration to serve a UI5 app dependency via ui5-middleware-ui5.

// Install the middleware as dev dependency npm install ui5-middleware-ui5 --save-dev // In your ui5.yaml (specVersion: "3.0"), add the middleware configuration: // server: // customMiddleware: // - name: ui5-middleware-ui5 // afterMiddleware: compression // configuration: // modules: // my-ui5-app: // mountPath: "/myapp" // // The moduleId "my-ui5-app" must be the name of a npm dependency containing a UI5 app. // Then start your server with: ui5 serve

ui5 --version

Debug

Known issues

breakingVersion 3.x requires UI5 CLI V3 and specVersion '3.0'. Incompatible with UI5 CLI V2.

fix

Upgrade to UI5 CLI V3 and update your ui5.yaml to specVersion: '3.0'.

affects: >=3.0.0 <4.0.0

deprecatedVersion 2.x (if available) is deprecated; upgrade to v3 to get latest features and security fixes.

fix

Upgrade to v3 and migrate to UI5 CLI V3.

affects: <3.0.0

gotchaThe middleware uses express router internally; be careful with mountPath collisions when multiple modules are configured.

fix

Ensure each module's mountPath is unique to avoid route conflicts.

affects: >=3.0.0

gotchaConfiguration options like configFile, workspaceConfigFile are relative to the UI5 app root, not the consumer project.

fix

Place referenced files inside the UI5 app's directory.

affects: >=3.0.0

breakingThe 'default' workspace lookup changed in UI5 CLI V3; ensure workspaceName matches the workspace defined in the UI5 app.

fix

Set workspaceName explicitly in the middleware configuration if the default workspace is not 'default'.

affects: >=3.0.0

Errors

Common errors & fixes

Cannot find module '@ui5/fs' or '@ui5/project'

Missing required peer dependencies.

fix

npm install @ui5/fs @ui5/project @ui5/server --save-dev

UI5 server does not start: Requires specVersion "3.0"

ui5.yaml uses an older specVersion (e.g., "2.0" or "1.0").

fix

Update ui5.yaml: specVersion: "3.0" and ensure you have UI5 CLI V3 installed.

Middleware not included: Could not find module 'ui5-middleware-ui5'

Package not installed or missing from node_modules.

fix

npm install ui5-middleware-ui5 --save-dev

TypeError: Cannot read properties of undefined (reading 'getMiddleware')

Incorrect configuration in ui5.yaml; the middleware name is misspelled or the afterMiddleware value is wrong.

fix

Verify middleware name: 'ui5-middleware-ui5', and ensure afterMiddleware points to an existing middleware like 'compression'.

Upgrade

Version history

3.5.0latest on npm

Audit

Dependencies

@ui5/fsrequiredpeer dependency for file system access in UI5 build

@ui5/projectrequiredpeer dependency for UI5 project configuration

@ui5/serverrequiredpeer dependency for UI5 server framework

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/ui5-community/ui5-ecosystem-showcase ↗

packagehttps://www.npmjs.com/package/ui5-middleware-ui5 ↗