| name | rspace-empty-integration |
| description | Scaffold a new "empty" RSpace integration end-to-end (Liquibase migration, sysadmin/user toggles, Apps-page card, TinyMCE toolbar icon opening a blank-bodied dialog with the integration's name as the chrome title). Use when a user asks to add, scaffold, create, or generate a new integration in the rspace-web codebase, mentions an integration name (e.g. "add a Galaxy/Foo/Bar integration"), or refers to "empty integration", "integration skeleton", or "new App". Do not use this skill when the request requires authentication (OAuth/API key), per-user configuration, deployment URLs, or backend Java services — those layers must be added by hand on top of the empty scaffold. |
RSpace Empty Integration Skill
Scaffold a new RSpace integration with the minimum surface area: database
toggles, an Apps-page card, and a TinyMCE toolbar icon that opens a blank
dialog whose title chrome is the integration name. Authentication, deployment
URLs, and domain logic are out of scope.
Quick start
Inputs to gather from the user:
<Name> — PascalCase (e.g. Galaxy)<ticket> — Liquibase changeset suffix (e.g. rsdev-1234)
Derived: <NAME> = uppercase, <name> = lowercase, <DATE> = today's date in
YYYY-MM-DD.
Workspace root: the repo root (the directory containing pom.xml and mvnw).
Workflow
Work through this checklist in order. Do not skip steps. All edits must be
idempotent: detect existing entries and refuse to overwrite.
1. Read the spec
Read DevDocs/DeveloperNotes/EmptyIntegrationSkillPlan.md for full context
on what is and isn't in scope, and re-read it before each ambiguous decision.
2. Verify prerequisites
- Confirm
pom.xml exists at the workspace root.
- Confirm
<NAME> is not already a key in
src/main/webapp/ui/src/eln/apps/useIntegrationsEndpoint.ts IntegrationStates
type. If it is, abort with a clear message — the integration already exists.
3. Create new files (9)
For exact file contents and templates, see REFERENCE.md:
4. Modify existing files (16)
Each edit must preserve existing alphabetical ordering. See
REFERENCE.md for the exact insertion patterns.
Verify every edit takes effect. Some edit tools may report success
without actually applying the change. After each modification, run a quick
grep for the inserted string in the target file. If it isn't present,
re-apply the edit using a deterministic Python script
(content.replace(needle, replacement, 1)) rather than retrying the same
tool call.
5. Build the frontend bundles
The TinyMCE dialog body (dialog.html) loads a Vite bundle that does not
exist until the UI is built. Run the build now so the integration is fully
functional immediately after the scaffold is applied:
pnpm run build
⚠️ This step is mandatory. Without it, clicking the toolbar button opens
a blank dialog with a console error (Failed to load resource: tinymce<Name>.js). The Apps-page card and sysadmin toggle work without the
build, but the TinyMCE dialog will not load.
6. Verify
Run the frontend type-check and lint to catch typos in the generated edits:
pnpm run tsc && pnpm run lint
Optionally run the smoke test for the new TinyMCE component:
pnpm run test src/tinyMCE/<name>/__tests__/<Name>.test.tsx
To verify the backend changes (Liquibase changeset applied, SystemPropertyName enum correct, integration visible in the API), run the existing MVC integration test against a running database:
mvn test -Dtest=IntegrationControllerMVCIT#getAllIntegrations
Alternatively, start the app and confirm <NAME> appears as a key in the response from:
GET http://localhost:8080/integration/allIntegrations
7. Report manual follow-ups
After the scaffold is in place, output a checklist of work the developer must
complete by hand: replace placeholder card strings, replace
TODO_<NAME>_DOC_ID in DocLinks.ts, hand-tune LOGO_COLOR, replace the
placeholder logo and TinyMCE icon SVGs, and pick the right category in
settings_mod.js.
Out of scope
This skill does not handle: OAuth, API-key auth, per-user options,
deployment URLs, backend services/controllers/DAOs, archive export,
per-text-field React components (the externalWorkFlows bundle pattern), or
the enabledFileRepositories / fileRepositoriesMenu / "Insert from…" menu
plumbing. If any of these are needed, scaffold the empty integration first,
then add those layers by hand following
DevDocs/DeveloperNotes/CreatingNewIntegration.md and
src/main/webapp/ui/src/eln/apps/AddingANewIntegration.md.
