Repository navigation
feat(device-client): re-export the types its public api exposes - #132
Merged
Merged
Conversation
The app may not name orbyn-contracts (rule D6). orbyn-device-client now re-exports every type of another Engine crate that its public API exposes, and orbyn-client re-exports the contract, crypto and sync types its Engine methods use. No behaviour change.
3 of 4 tasks
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.
Summary
orbyn-contracts.orbyn-device-clientre-exports every foreign type its public API exposes:DevicePlatform,DeviceApp,DeviceState,Device,DeviceList,DeviceRemoval,PendingApproval,Engine,Snapshot,Applied,RejectedFields,RefusedEnvelope,ClientError,Peer,Local,Quarantined,Trashed,Fields,Stamp,DeviceKeys,DevicePublic,Zeroizing.orbyn-clientre-exports the contract types itsEnginemethods take or return (plusDeviceKeys,DevicePublic,Fields,Stamp).Item/ItemError, internal request/response bodies,orbyn-auth-client(no public use), the pairing structs wrapped byApproverApproval/JoinedApproval. Listed in docs/device-client.md ("One crate to depend on").Testing
orbyn-device-client/tests/single_crate.rs,orbyn-client/tests/reexports.rs); a check fails if the first file names another Engine crate. Mutations (an extra contracts import, a dropped re-export) were caught.Co-authors
none
AI usage
Checklist
docs/architecture.mdwith any rule change; generated wire types with any contract change