Class HomeportClient

constructor

• new HomeportClient(config: HomeportConfig): HomeportClient

  Parameters

  • config: HomeportConfig

  Returns HomeportClient

ReadonlybaseUrl

agents

• get agents(): AgentsNamespace

  Agent registration, lookup, search, lifecycle, facts, and versioning.

  Returns AgentsNamespace

billing

• get billing(): BillingNamespace

  Subscriptions, invoices, checkout sessions, and NP payment verification.

  Returns BillingNamespace

developers

• get developers(): DevelopersNamespace

  Developer key management and earnings.

  Returns DevelopersNamespace

federation

• get federation(): FederationNamespace

  Federation peers, status, agents, and A2A communication.

  Returns FederationNamespace

orchestration

• get orchestration(): OrchestrationNamespace

  Workflows, runs, delegation, patterns, conflicts, routing, and index sync.

  Returns OrchestrationNamespace

payments

• get payments(): BillingNamespace

  Backward-compatible alias for payment/currency callers.

  Returns BillingNamespace

switchboard

• get switchboard(): OrchestrationNamespace

  Backward-compatible alias for protocol bridge/switchboard callers.

  Returns OrchestrationNamespace

trust

• get trust(): TrustNamespace

  Resolution, reputation, trust scores/frameworks/graph, compliance, and analytics.

  Returns TrustNamespace

webhooks

• get webhooks(): WebhooksNamespace

  Webhook subscription management.

  Returns WebhooksNamespace

deepHealth

• deepHealth(): Promise<
      HomeportHealthStatus & { degradedChecks: string[]; healthy: boolean },
  >

  Deep health check — returns full health status including individual subsystem checks. Unlike health(), this provides a summary healthy boolean and per-check details.

  Returns Promise<HomeportHealthStatus & { degradedChecks: string[]; healthy: boolean }>

health

• health(): Promise<HomeportHealthStatus>

  GET /health

  Returns Promise<HomeportHealthStatus>

invalidateCache

• invalidateCache(pattern?: string | RegExp): void

  Invalidate cache entries matching the given pattern.

  Parameters

  • Optionalpattern: string | RegExp

  Returns void

isHealthy

• isHealthy(): Promise<boolean>

  Convenience: is NNN healthy? Never throws. Uses deepHealth() so the result is consistent — a service with degraded subsystems is not considered healthy.

  Returns Promise<boolean>

setTraceContext

• setTraceContext(ctx: { traceparent?: string; tracestate?: string }): void

  Update trace context for subsequent requests.

  Parameters

  • ctx: { traceparent?: string; tracestate?: string }

  Returns void