Build toolBuild tooltypeRuns at build time. Nothing of it ships in the deployed application.See every one →What this type is →by a community orgby a community orgoriginPublished by a community organisation, so it outlives any one maintainer.See every one →

ui5-middleware-index

A UI5 dev-server middleware that delivers a configured welcome page, index.html by default, for the root path instead of the ui5-server directory listing.

Redirects the root path of a UI5 app served locally to a configured HTML file — welcomeFile in ui5.yaml, index.html by default — instead of the directory listing ui5-server shows there otherwise. The file is delivered whenever the app's root URL is requested with a trailing slash. An older index option is documented as deprecated in favour of welcomeFile.

Facts

Latestv3.1.4ReleasedLast pushLicenceApache-2.0

Where it sits

Lives in
Provides
Build and dev-server toolingUI5Build and dev-server toolingcapabilityServing an app locally and building it for deployment — proxying a backend, transpiling, bundling, and shaping the result for whatever will host it.

Who is behind it

UI5 CommunityUI5 CommunityOrganisationMaintains this
In the atlas: maintains 69
@ui5-community
maintainerDimitar FenerskiPersonContributes to this
In the atlas: contributes to 23
@dfenerski
Florian VogtPersonContributes to this
In the atlas: contributes to 50, wrote 2
@flovogt
Marian ZeisPersonContributes to this
In the atlas: maintains 35, contributes to 86, wrote 25
@marianfoo
Peter MuessigPersonContributes to this
In the atlas: maintains 14, contributes to 80, wrote 1
@petermuessig
Merlin BeutlbergerPersonContributes to this
In the atlas: contributes to 18, wrote 1
@RandomByte
Jakob Marius KjaerPersonContributes to this
In the atlas: maintains 2, contributes to 24, wrote 1
@uxkjaer
Volker BuzekPersonContributes to this
In the atlas: maintains 7, contributes to 53, wrote 2
@vobu
7 contributors

What it declares

Every artifact

Type
Build tool
Origin
By a community org

As a build tool

Distributed through
npm

Connections1

Install

npm add ui5-middleware-index

Derived from the package name. No recipe recorded; the README has the configuration.

README

quoted from ui5-community/ui5-ecosystem-showcase under Apache-2.0, read
ui5-community/ui5-ecosystem-showcase/packages/ui5-middleware-index/README.mdOn GitHub

UI5 middleware for delivering a welcome/start/'index' page to the client

👋 This is an open‑source, community‑driven project, developed and actively monitored by members of the UI5 community. You are welcome to use it, report issues, contribute enhancements, and support others in the community.

Middleware for ui5-server, delivering the $index.html of choice (instead of the directory listing).

Prerequisites

⚠️ UI5 CLI Compatibility All releases of this UI5 CLI extension using the major version 3 require UI5 CLI V3. Any previous releases below major version 3 (if available) also support older versions of the UI5 CLI. But the usage of the latest UI5 CLI is strongly recommended!

Install

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

Configuration options (in $yourapp/ui5.yaml)

  • debug: <boolean>, default: false
  • welcomeFile: <string>, default: index.html the file to redirect to when the root path / is requested
  • index: <string>, default: index.html deprecated file inside $yourapp to deliver for http://<host>:<port>/

Usage

  1. Define the dependency in $yourapp/package.json:
"devDependencies": {
    // ...
    "ui5-middleware-index": "*"
    // ...
}
  1. configure it in $yourapp/ui5.yaml:
server:
  customMiddleware:
  - name: ui5-middleware-index
    afterMiddleware: compression
    configuration:
      welcomeFile: "index_peter.html"

How it works

The middleware delivers the configured index HTML-file to the client if the FQDN + trailing slash / is requested in the browser.

Development

If you want to contribute to ui5-middleware-index, please use Prettier for code formatting/style and apply the rules from ./.prettierrc. Thanks 🙏!

License

This work is licensed under Apache 2.0.

Built with care (and a lot of caffeine). If this helped you build, test, or ship, the next coffee — or drink — is on you when you bump into a contributor.

Apache-2.0, read

History

Latest

v3.1.4

Notes

Note: Version bump only for package ui5-middleware-index

  1. v3.1.3

    Notes

    Note: Version bump only for package ui5-middleware-index

  2. v3.1.2

    Notes

    Note: Version bump only for package ui5-middleware-index

  3. v3.1.1

    Notes

    Note: Version bump only for package ui5-middleware-index

  4. v3.1.0

    Features 1

    Notes
    Features
    • enhanced v4 compat + update dependencies (#1070) (2d7ed16)
  5. v3.0.5

    Notes

    Note: Version bump only for package ui5-middleware-index

  6. v3.0.4

    Fixes 1

    Notes
    Bug Fixes
    • ui5-middleware-index: re-enable support for URL parameters (#914) (5294d42), closes #912
  7. v3.0.3

    Notes

    Note: Version bump only for package ui5-middleware-index

  8. v3.0.2

    Fixes 1

    Notes
    Bug Fixes
    • consistent request path handling of all middlewares (#833) (11ad435), closes #817
  9. v3.0.1

    Fixes 1

    Notes
    Bug Fixes
    • ui5-middleware-cfdestination: support UAA flow (#828) (20a0df1), closes #817
  10. v3.0.0dated in the atlas

    Breaking 1, Features 2

    Notes
    Features
    BREAKING CHANGES
    • The support for UI5 Tooling V2 has been removed
  11. v0.3.0

    Breaking 26, Features 1

    Notes
    Features
    BREAKING CHANGES
    • new package manager

    • refactor: updated tests to pass with pnpm

    • refactor: iasync still failing

    • feat(ui5-tooling-modules): support pnpm / node_modules symlinks

    • fix(ui5-app): make Karma work with pnpm

    • chore(ui5-app): remove uiveri5 from sample

    • chore(ui5-app): add updated wdio.conf

    • fix: make prettier and eslint work with pnpm

    • fix: fix cf_dest tests

    restructured tests and added node_modules as symlink

    • fix(ui5-app): adding eslint for wdio and mocha

    • chore(ui5-middleware-cfdestination): cleanup

    • feat(ui5-tooling-modules): add bundling support for AMD

    • chore(ui5-tooling-modules): cleanup

    • chore: fix code style

    • fix(ui5-task-flatten-library): support files without extensions

    • refactor: updated tests to pass with pnpm

    • feat(ui5-tooling-modules): support pnpm / node_modules symlinks

    • fix: make prettier and eslint work with pnpm

    • fix: update actions, lerna, vscode for pnpm

    • chore: only run test on tooling extensions

    • chore: use sequential tests for ava

    • chore: add @ui5/cli dev dependency for ava tests

    • chore: enable support for local act GH action tests

    • chore: add docu for local GitHub action execution

    • chore: docu cleanup

    • chore: re-add ncu scripts

    Co-authored-by: Peter Muessig peter.muessig@sap.com

  12. v0.2.10

    Notes

    Note: Version bump only for package ui5-middleware-index

  13. v0.2.9

    Other 1

    Notes
    Reverts
    • Revert "chore: add metadata to package.json for all packages for ui5-community website (#600)" (#601) (b6037d4), closes #600 #601
  14. v0.2.8

    Notes

    Note: Version bump only for package ui5-middleware-index

  15. v0.2.7

    Fixes 1

    Notes
    Bug Fixes
    • ensure middlewares work with Karma connect middleware (#584) (c0ae49f)
  16. v0.2.6

    Notes

    Note: Version bump only for package ui5-middleware-index

  17. v0.2.5

    Fixes 1

    Notes
    Bug Fixes
  18. v0.2.4

    Fixes 1

    Notes
    Bug Fixes
  19. v0.2.3

    Notes

    Note: Version bump only for package ui5-middleware-index

  20. v0.2.2

    Notes

    Note: Version bump only for package ui5-middleware-index

  21. v0.2.1

    Notes

    Note: Version bump only for package ui5-middleware-index

  22. v0.2.0

    Features 1

    Notes
    Features
    • pwa: added pwa build for sample application (c36baf2)
  23. v0.1.1

    Notes

    Note: Version bump only for package ui5-middleware-index

  24. v0.1.0

    Features 1

    Notes
    Features
614downloads per week, npm
Weekly downloads for ui5-middleware-index26 complete calendar weeks from 2026-04-20 to 2026-10-18; the latest total is 614.20 Apr – 26 Apr: 3,74127 Apr – 3 May: 3,5544 May – 10 May: 3,60211 May – 17 May: 2,82918 May – 24 May: 3,43225 May – 31 May: 2,8561 Jun – 7 Jun: 1,5668 Jun – 14 Jun: 1,98615 Jun – 21 Jun: 2,66122 Jun – 28 Jun: 2,17229 Jun – 5 Jul: 1,9146 Jul – 12 Jul: 1,86613 Jul – 19 Jul: 1,80420 Jul – 26 Jul: 1,93727 Jul – 2 Aug: 1,9453 Aug – 9 Aug: 2,24110 Aug – 16 Aug: 3,04317 Aug – 23 Aug: 6,81724 Aug – 30 Aug: 4,16631 Aug – 6 Sept: 3,4047 Sept – 13 Sept: 1,84414 Sept – 20 Sept: 2,14621 Sept – 27 Sept: 2,72028 Sept – 4 Oct: 2,4865 Oct – 11 Oct: 1,71912 Oct – 18 Oct: 614
Build and dev-server tooling
  1. UI5 ToolsVS Code extension to serve, proxy, build and deploy UI5 projectsfrom UI5
  2. ui5-middleware-route-proxyUI5 server middleware proxying route prefixes to a backendfrom UI5
  3. ui5-task-cachebuster-indexingUI5 builder task preparing build output for the cachebusterfrom UI5
  4. ui5-task-transpile-genUI5 builder task transpiling ES6 to ES5 with Babelfrom UI5
  5. ui5-middleware-odata-recorderUI5 middleware recording OData traffic as mock server datasetsfrom UI5
  6. ui5-plugin-loaderUI5 Tooling v4 extension that registers other extensionsfrom UI5
  7. ui5-deployerUI5 Tooling module deploying Fiori/UI5 apps to SAP systemsfrom UI5
  8. ui5-task-dts-generatorUI5 builder task generating d.ts type declarationsfrom UI5
  9. ui5-task-minifierUI5 builder task minifying HTML, CSS and JSON filesfrom UI5
  10. ui5-middleware-oidcUI5 dev server middleware adding an OpenID Connect loginfrom UI5
  11. generator-ui5-library-af-deployYeoman generator for Application Frontend config in UI5 librariesfrom UI5
  12. ui5-middleware-destinationUI5 Tooling middleware proxying destinations and neo-app.json routesfrom UI5
  13. ui5-task-check-eocpUI5 build task warning when the app's UI5 version reaches EOCPfrom UI5
  14. @ui5/cliUI5 Tooling command line for project setup, dev server and buildfrom UI5
  15. ui5-task-btp-manifestUI5 Tooling task writing the service name into the importer manifestfrom UI5
  16. ui5-middleware-approuterUI5 CLI middleware proxying the dev server through @sap/approuterfrom UI5
  17. ui5-middleware-capUI5 CLI middleware running a CDS server inside the UI5 dev serverfrom UI5
  18. ui5-middleware-hmrExperimental UI5 middleware for hot module replacementfrom UI5
  19. ui5-middleware-iasyncUI5 middleware syncing interactions across browsers over websocketfrom UI5
  20. ui5-middleware-livereloadLive reload middleware for the UI5 dev serverfrom UI5
  21. ui5-middleware-oneloginUI5 middleware logging in with Playwright and reusing the sessionfrom UI5
  22. ui5-middleware-serveframeworkUI5 middleware serving a locally built UI5 frameworkfrom UI5
  23. ui5-middleware-servestaticUI5 middleware serving static resources from a path or npm packagefrom UI5
  24. ui5-middleware-simpleproxyDev-server middleware proxying requests to a backend systemfrom UI5
  25. ui5-middleware-ui5UI5 middleware including one UI5 application in anotherfrom UI5
  26. ui5-middleware-webjarsUI5 middleware serving static resources from JAR files (WebJars)from UI5
  27. ui5-middleware-websocketWebSocket support for Express-based dev servers such as UI5'sfrom UI5
  28. ui5-task-cachebusterUI5 builder task cachebusting standalone UI5 applicationsfrom UI5
  29. ui5-task-copyrightUI5 builder task appending copyright headers to source filesfrom UI5
  30. ui5-task-flatten-libraryUI5 builder task flattening library output for SAP NetWeaverfrom UI5
  31. ui5-task-i18ncheckUI5 builder task checking XML views for missing i18n textsfrom UI5
  32. ui5-task-minify-xmlUI5 builder task minifying XML views and fragmentsfrom UI5
  33. ui5-task-pwa-enablerUI5 builder task turning a UI5 app into a progressive web appfrom UI5
  34. ui5-task-zipperBuild task packaging the UI5 build result as a zip archivefrom UI5
  35. ui5-tooling-lessUI5 CLI extension compiling Less files into CSSfrom UI5
  36. ui5-tooling-modulesUI5 tooling extensions loading npm packages as UI5 modulesfrom UI5
  37. ui5-tooling-stringreplaceUI5 CLI extension for string replacement during the buildfrom UI5
  38. ui5-tooling-transpileUI5 CLI extension transpiling code during the UI5 buildfrom UI5
  39. @ui5/loggerInternal logger of the UI5 CLIfrom UI5
  40. @ui5/middleware-code-coverageUI5 CLI middleware for Istanbul code coveragefrom UI5
  41. @ui5/tooling-webcDeprecated UI5 Tooling extensions for UI5 Web Components wrappersfrom UI5

Details

Sources4
Added by handdiscovered herechecked
npm registry, ui5-middleware-indexversion, releases, installschecked
packages/ui5-middleware-index/README.mdquoted, and what the entry declareschecked

Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.

Compatibility and provenance
latestv3.1.4
first release
releases and cadence25, ~101d median
discovered viaAdded by hand
first seen in the atlas
ecosystem and domainui5, developer-experience
Contributors7
History in the atlas1
  1. First seen.
For your agent
Ref
artifact:ui5-community-ui5-middleware-index
JSON
/artifacts/ui5-community-ui5-middleware-index.json
MCP
Connecting an agent