surface

package

v1.2.40 Latest Latest Go to latest Published: Apr 21, 2026 License: AGPL-3.0 Imports: 2 Imported by: 0

Details

Package surface defines the deploy-time ActivityPub federation surface contract.

This section is empty.

This section is empty.

func SharedInboxURL(baseURL string) string

SharedInboxURL returns the canonical shared inbox URL when the surface advertises it.

type EndpointManifest struct {
	Path       string
	Advertised bool
	Policies   []MethodPolicy
}

EndpointManifest describes the deploy-time contract for one federation endpoint.

func SharedInbox() EndpointManifest

SharedInbox returns the shared inbox endpoint contract.

func (e EndpointManifest) AllowsMethod(method string) bool

AllowsMethod reports whether the method is served as an allowed success path.

func (e EndpointManifest) MethodStatus(method string) (int, bool)

MethodStatus returns the explicit served status for a method when one is defined.

func (e EndpointManifest) ServedMethods() []string

ServedMethods returns the ordered list of explicitly served methods for the endpoint.

func (e EndpointManifest) ServesMethod(method string) bool

ServesMethod reports whether the endpoint is explicitly served for the given method.

type FederationManifest struct {
	SharedInbox EndpointManifest
}

FederationManifest is the source of truth for deploy-time federation surface support.

func Current() FederationManifest

Current returns the active deploy-time federation surface manifest.

type MethodPolicy struct {
	Method     string
	Served     bool
	StatusCode int
}

MethodPolicy describes how a served federation endpoint handles an HTTP method.