feat(ui): export BUILT_IN_COMMAND_IDS, add commands.has and commands.require (SD-2920)#3095
Conversation
…require (SD-2920) Config-driven toolbars had no way to validate their command id arrays. `ui.commands.get(id)` returns undefined silently for unknown ids, so typos surfaced as buttons that rendered disabled with no warning at startup, in the type checker, or in the dev console. This PR exposes three small helpers on the public superdoc/ui surface: - BUILT_IN_COMMAND_IDS: readonly array of the canonical built-in command ids. PublicToolbarItemId is now derived from this const so the type and runtime list cannot drift from each other. - ui.commands.has(id): boolean check, true for built-ins and currently registered customs. - ui.commands.require(id): throwing variant for trusted dispatch sites (keyboard routers, tests, internal pipelines) where an unknown id is a bug not a user error. Re-exported through superdoc/ui (and the public superdoc/ui sub-entry) so consumers can import directly from the entry point they already use. Tests pin: BUILT_IN_COMMAND_IDS matches the runtime toolbar registry (drift guard), has() returns true for every built-in and toggles correctly across custom register/unregister, require() returns handles for built-ins and customs and throws for unknown ids. Consumer-typecheck exercises every helper at value level.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c6dd9af03e
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
…es (SD-2920) - ui.commands.register() now refuses ids that match Proxy property names (register / get / has / require). Index access on the ui.commands Proxy intercepts those names before the registry lookup, so a custom command registered under one of them would be reachable through get(id) / require(id) but unreachable through ui.commands[id]. Refuse + warn instead, matching the build-in collision pattern. - override: true does not bypass: Proxy index access cannot be routed around at registration time. Use a namespaced id instead (e.g. 'company.has'). - Test pins the contract: every reserved name is refused, has(id) returns false for the refused id, index access still returns the Proxy helper. - Replace em-dashes added in the prior commit per project rule.
|
🎉 This PR is included in @superdoc-dev/mcp v0.3.0-next.37 The release is available on GitHub release |
|
🎉 This PR is included in vscode-ext v2.3.0-next.81 |
|
🎉 This PR is included in @superdoc-dev/react v1.2.0-next.79 The release is available on GitHub release |
|
🎉 This PR is included in superdoc-cli v0.8.0-next.55 The release is available on GitHub release |
|
🎉 This PR is included in superdoc v1.30.0-next.38 The release is available on GitHub release |
|
🎉 This PR is included in superdoc-sdk v1.8.0-next.40 |
|
🎉 This PR is included in superdoc-cli v0.9.0 The release is available on GitHub release |
|
🎉 This PR is included in superdoc v1.32.0 The release is available on GitHub release |
|
🎉 This PR is included in @superdoc-dev/mcp v0.4.0 The release is available on GitHub release |
|
🎉 This PR is included in @superdoc-dev/react v1.3.0 The release is available on GitHub release |
|
🎉 This PR is included in vscode-ext v2.4.0 |
|
🎉 This PR is included in superdoc-sdk v1.9.0 |
2 participants
Config-driven toolbars had no way to validate their command id arrays. `ui.commands.get(id)` returns undefined silently for unknown ids, so typos surfaced as buttons that rendered disabled with no warning at startup, in the type checker, or in the dev console.
This PR exposes three small helpers on the public `superdoc/ui` surface:
`BUILT_IN_COMMAND_IDS` — readonly array of canonical built-in command ids. `PublicToolbarItemId` is now derived from this const, so the type and runtime list cannot drift from each other.
`ui.commands.has(id)` — boolean check, true for built-ins and currently registered customs.
`ui.commands.require(id)` — throwing variant for trusted dispatch sites (keyboard routers, tests, internal pipelines) where an unknown id is a bug.
Linear: SD-2920
8 vitest cases pin behavior: BUILT_IN_COMMAND_IDS matches the runtime toolbar registry (drift guard), has() flips correctly across custom register/unregister, require() throws for unknown ids.
Consumer-typecheck exercises every helper at value level.
Verified: `pnpm --filter @superdoc/super-editor test src/ui/` passes 181/181; `pnpm --filter superdoc build` clean; consumer-typecheck on the modified file clean.