Update Roam API types from current docs - #66
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Team Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
mdroidian
left a comment
mdroidian
left a comment
There was a problem hiding this comment.
Direct links to the exact Roam documentation blocks used for these type additions.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
![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: 18099292d2
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
mdroidian
left a comment
mdroidian
left a comment
There was a problem hiding this comment.
Follow-up documentation links for the contracts tightened after the independent audit.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3668acafd6
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
mdroidian
left a comment
mdroidian
left a comment
There was a problem hiding this comment.
Fresh-context audit follow-up. Each corrected contract below includes a screenshot of the exact live Roam documentation block that informed the line.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d776fcbd72
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
d776fcb to
b0b3d06
Compare
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b0b3d067fd
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 83fb4a0aca
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 83fb4a0aca
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
83fb4a0 to
d55ed6d
Compare
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d55ed6d849
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "disable-hotkey"?: boolean; | ||
| "default-hotkey"?: string | string[]; |
There was a problem hiding this comment.
When an extension registers a command through extensionAPI.ui.commandPalette.addCommand using the previously supported defaultHotkey or disableHotkey properties, this change rejects the command as an excess-property error. The kebab-cased names belong to the raw window.roamAlphaAPI command shape; retain the camel-cased options on AddCommandOptions so existing extension consumers continue to compile.
Useful? React with 👍 / 👎.
1 participant
Summary
Prepare
roamjs-components0.91.0 with Roam Alpha API and Extension API declarations aligned with the current developer documentation. This fixes missing API surfaces and incorrect argument/return types for extension consumers.propson both blocks and pages. Model deletion results on namespaced methods and legacy aliases.File, base64 metadata, or their union fromfile.getoptions. Allow synchronousasTokenUsercallbacks to return write promises and document that writes must be issued before any await.Validation
npm run test:typesnpm run test:unit— 2 passing testsnpm run buildnpm run lintgit diff --checkLive verification on Roam API 1.1.5 used an authenticated DG Playwright test slot and a temporary developer extension receiving the real ExtensionAPI from Roam. Passed coverage:
asTokenUserpreserving a synchronously issued write promise. This did not use an AI token.Temporary pages, comments, uploaded file, UI registrations and the developer extension were removed. Developer mode was restored to its original setting. Temporary-page and settings-panel screenshots were inspected. The initial smoke pass captured no page errors; later checks used explicit runtime/UI assertions rather than a comprehensive error-log gate.
Observed documentation differences: reorder/sidebar-add resolve to
nullin this build, while their declarations intentionally expose an unusedvoidreturn; a command callback receives an unusednullargument. No new consumer-facing type defect was demonstrated by this pass.Not verified: authenticated AI token attribution/scope enforcement; semantic-search results (embeddings disabled); admin/read-only and multi-user permission cases; whole-graph/multiselect/drag-drop and every context-menu/rendering variant; persistent reload across browser restarts; other platforms; global undo/redo or removal of all watches. The full repository Playwright integration suite was not run. Committed API examples remain compile-only tests.
Documentation
Compared against the live Developer Hub, Roam Alpha API, and the roamdocs.fyi mirror, including the Extension API reference.