Add shared cross-surface control overlay contract#9
Merged
Conversation
abrichr
marked this pull request as ready for review
July 25, 2026 21:21
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.
Outcome
Adds the canonical, cross-surface control-overlay contract to
openadapt-types.Desktop, hosted browser viewers, and evidence-media renderers can now share one
versioned vocabulary rather than evolving independent state models.
Contract
openadapt.control-overlay-frame/v1openadapt.control-overlay-timeline/v1The public frame has no free-form runtime text and rejects screenshots, action
targets, typed values, identities, URLs, logs, report bodies, user-authored
workflow names, and every other unknown field. Only synthetic or reviewed
sanitized_publictimelines are admitted.Validation
126 passedExact local artifact SHA-256:
65c8986a95aa2a530d997a49a099700cb0071e7bdfcb404e21c407be4401505e270c2462fa7a6d220c1c01327d22b08ba987c49e79504746f0be22b6b24b35abConsumer follow-up
This PR intentionally does not edit concurrent Desktop #61 or Cloud #151.
After release, each consumer should pin the exact
openadapt-typesversion,generate its TypeScript declarations/constants from the packaged JSON Schemas,
and retain only surface-specific rendering and transport code. Producers must
validate through
ControlOverlayFrameV1/ControlOverlayTimelineV1before IPCor evidence inventory; consumers must verify the manifest pack/media binding
before composition. The migration should delete the duplicated phase/status/
label/state-ID sources in each PR and add a generated-contract drift check.