Repository navigation
Document the packages as they are published - #26
Merged
Merged
Conversation
Both packages are on npm since 2026-09-27: cap2ui5@0.1.0 and
@abap2ui5/node-runtime@1.145.0, which the plugin pins exactly.
- Rename @abap2ui5/runtime to @abap2ui5/node-runtime everywhere it names
the package; ROADMAP keeps the old name and says so.
- Drop /z2ui5/webapp/ and the webapp option: the GET page embeds the whole
UI5 component, and the plugin serves no static frontend.
- Rewrite the quickstart to run verbatim: cds init --nodejs --add
tiny-sample, npm install cap2ui5, cds watch, and the startup lines as
the entry point. Remove the "not on npm yet" box.
- Move every example to import: cds init --nodejs makes an ES module
project, where a require() in an app file fails the whole runtime boot.
verify-refs now checks import { ... } from "cap2ui5" like require.
- Deployment: the production build as measured, and the approuter route
with csrfProtection false that roundtrips need until a runtime release
carries abap2UI5/abap2UI5#2802 (open). Drop the /z2ui5/webapp/ route.
- Troubleshooting: the ESM require failure and the approuter 403.
- AGENTS.md ground truth, HANDOVER.md and ROADMAP §25 follow.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CegF7ccAM1UDD7VSXU85Tw
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Both packages are on npm since 2026-09-27:
cap2ui5@0.1.0and@abap2ui5/node-runtime@1.145.0, which the plugin pins exactly. This PR updates the site to match what a reader actually gets from npm today. It also documents the approuter setting a BTP deployment needs right now.What changed
@abap2ui5/node-runtimeinstead of@abap2ui5/runtime. ROADMAP keeps the old name in its dated sections, and a note at the top says so./z2ui5/webapp/and thewebappoption from getting-started, project-structure, configuration, deployment (including its approuter route), protocol, what-is, why, user-exit, devtools, index and architecture. The GET page embeds the whole UI5 component.cds init my-cap2ui5-app --nodejs --add tiny-sample,npm install,npm install cap2ui5,srv/apps/hello.js,cds watch. The page points to the[cap2ui5] HELLO http://…?app_start=HELLOstartup lines as the entry point, because CAP's/index doesn't list the route. It also has a tip about theNO_DRAFT_ENTRY_OF_PREVIOUS_REQUEST_FOUNDerror aftercds watchrestarts. The "not on npm yet" box is gone.importinstead ofrequirein every example.cds init --nodejscreates an ES module project, where arequirein an app file breaks the whole runtime boot. A box on getting-started and a troubleshooting entry cover CommonJS projects and.cjsfiles.scripts/verify-refs.mjsnow checksimport { … } from "cap2ui5"(includingasaliases),cap2ui5/<sub>import specifiers, and the retiredabap2UI5/…package, the same way it checksrequire."csrfProtection": falsein front of the generated catch-all. The page explains why it is needed (approuter 23.0.0xsrf-token-handler; the frontend up to 1.145.0 sends no token) and why it is safe (abap2UI5's own Origin/Referer check against Host or X-Forwarded-Host).requirefailure) and "403 behind the approuter".webapp, runtime stand-in withoutwebapp/,importin examples), HANDOVER.md (publishing done; the approuter CSRF item is open) and ROADMAP §25..verify-refs-ignoreentries (app/webapp,my_app) that no longer match anything.Verification
npm run check:cipasses against cap2UI5 and abap2UI5main(verify-refs with--require-checkout, then the VitePress build).cap2ui5doesn't export, acap2ui5/lib/nopeimport and anabap2UI5/coreimport. Each was reported with file and line./z2ui5/webapp/index.htmlreturns 404.requirefails the boot, and roundtrips return 500 "roundtrip failed".cds add hana+cds build --productionproducescap2ui5.Drafts.hdbtable,gen/srv/srv/apps/hello.jsandcap2ui5.Draftsincsn.json.cds add xsuaa,approuterwrites.deploy/app-router/xs-app.jsonwith one catch-all route,csrfProtection: true.csn.json. Both come from the brief and are described on the page as the brief states them.🤖 Generated with Claude Code
https://claude.ai/code/session_01CegF7ccAM1UDD7VSXU85Tw
Generated by Claude Code