Gateway design docs + submodule pointers (#57) - #72
Open
pplupo wants to merge 44 commits into
Open
Conversation
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…ances Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…objects Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…Index Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
… only Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…m insertion Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
… space Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…-wide search Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…xists Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…ow behavior Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…gles Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…tion API Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…ing option Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…dicated collection Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…rray Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…bjects Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…tation Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…ition Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…question Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
… is singular Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Documents every implemented command (13 Word, 16 Cell, 11 Slide - 40 total across the three editors done so far) with scope parameters, types, required/optional, return shapes, and request/response examples, generated directly from the committed command source (wordcommands.cpp/cellcommands.cpp/slidecommands.cpp) rather than from memory. Covers the wire protocol (request/response JSON, error codes), eo-ctl CLI usage, and lists the 5 deliberately-deferred commands with what they're blocked on. Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Adds required rect param and the pdf.getAllAnnots read-back mechanism;
defers pdf.addStamp (AscPDF.STAMP_TYPES enum values not locatable in the
vendored source); simplifies the ink annotation example to [x,y]-pair
paths, converted to the {x,y} object shape by the command's own script.
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
… apiBuilder.js Renames pdf.search to pdf.searchText; corrects getSelectedText's non-existent rect param to the real setSelection+getSelectedText sequence; corrects recognizeContent's expected OCR-text output to ApiDrawing[] class-type strings, matching what the method actually returns. Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Splits the original single-call pdf.applyRedact{page,rect} into the real
two-step workflow: pdf.addRedact (creates a pending annotation) then
pdf.applyRedact{} (document-wide, no params, throws if nothing pending).
Documents pdf.searchAndRedact's SearchProps shape and count-based result.
Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…lder.js Converts addPage's ApiPage result to an index and removePage's false-on- out-of-range return to a thrown error, matching the established SCRIPT_EXCEPTION contract; replaces E5.3's unverifiable 'remove the only page' scenario with a confirmed out-of-range case; adds pdf.getPageCount as the verification path for page-count changes. Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
Documents all implemented pdf.* commands (§E1-E5: form fields, annotations, text search/selection/extraction, redaction, page operations), a PDF CLI example session, and moves pdf.addStamp into the not-yet-implemented table. Renumbers the not-yet-implemented section to §7 and removes the stale 'PDF not yet implemented' note. Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
…reference.md Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
desktop-apps -> 3bad911fb (full gateway command set through PDF, eo-ctl, gateway.connect, eo-mcp). desktop-sdk -> 81df5a084 (in-process CDP bridge for the gateway). Signed-off-by: Peter P. Lupo <pplupo@gmail.com>
This was referenced Aug 19, 2026
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
1 participant
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.
Gateway design docs + submodule pointers for #57
Documentation and submodule pointer bumps for #57 (Local API / Daemon Mode) — the
actual implementation lives in the companion
desktop-sdkanddesktop-appsPRs;this PR carries the design/reference docs and points the submodules at their
gateway-ready commits.
What's here
cdp-gateway-cli-plan.md— architecture plan: in-process CDP bridge, transport,auth, build/test workflow.
gateway-test-case-designs.md— the full test matrix each command family wasbuilt against, including every correction made against the real
sdkjs/*/apiBuilder.jssource where the original design didn't match the actual API (wrong param shapes,
unserializable return types, id- vs range-based addressing, etc.) — each correction
cites the specific source file/line that motivated it.
gateway-api-reference.md— full command reference: wire protocol, CLI and MCPusage, every implemented command's
scopefields/return shape/examples, and atable of commands deliberately left unimplemented (with the reason why).
desktop-appsanddesktop-sdkbumped to the commits landing inthe companion PRs.
See #57 for the original request this implements.
Companion PRs: desktop-sdk#12 · desktop-apps#40