Skip to content

feat(api): add an optional registered-read interface - #20

Closed
Upd4ting wants to merge 1 commit into
mainfrom
feat/registered-read-interface
Closed

Upd4ting wants to merge 1 commit into
mainfrom
feat/registered-read-interface

Conversation

@Upd4ting

@Upd4ting Upd4ting commented Sep 13, 2026

Copy link
Copy Markdown
Member

Purpose

Add the optional @antelopejs/interface-api/registered-read subinterface without changing the root interface required of existing providers. This is a dependency foundation, not a complete document-attachment authorization implementation.

ExecuteRegisteredRead accepts a trusted registered GET route ID, a strict absolute pathname and optional server-selected query values. The provider runs the route's actual authorization pipeline in an isolated request. The caller must select the target from trusted server configuration and validate the returned entity and content; registration alone is not object authorization.

The contract preserves credentials and peer address metadata on a detached transport. It refuses response interception, non-success statuses, redirects and streams. Transport-specific TLS methods and the live parent socket are deliberately not exposed. Parent query parameters are never inherited.

Verification

  • pnpm test: 83 passing.
  • pnpm lint, pnpm format:check, pnpm pack: pass; existing lint warnings remain.
  • The packed subpath is exercised by the companion API provider's 38 registered-read tests.
  • Oracle review completed; reported provider defects were corrected in the companion implementation.

Release order

Companion provider: AntelopeJS/api#40.

This PR must be merged and a new interface version published before the companion API provider can update its dependency floor and frozen lockfile. The current published package does not contain this export. No package publication, merge or deployment is part of this PR request.

@Upd4ting
Upd4ting marked this pull request as ready for review September 14, 2026 17:50
@Upd4ting
Upd4ting enabled auto-merge (squash) September 14, 2026 17:50
@Upd4ting Upd4ting closed this Sep 14, 2026
auto-merge was automatically disabled September 14, 2026 18:18

Pull request was closed

@Upd4ting
Upd4ting deleted the feat/registered-read-interface branch September 14, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant