Skip to main content

TypeScript API reference

This inventory is generated from the package's public export surface. Unknown or internal symbols are deliberately excluded.

  • AccountMcpBearerOptions — Interface; entry .. Public TypeScript interface AccountMcpBearerOptions.
  • AccountRefreshOptions — Interface; entry .. Public TypeScript interface AccountRefreshOptions.
  • AccountRefreshResult — Interface; entry .. Public TypeScript interface AccountRefreshResult.
  • AccountRevocationResult — Interface; entry .. Public TypeScript interface AccountRevocationResult.
  • AccountTokenClient — Class; entry .. Use a stored Account Token without ever handing it to a caller.
  • AccountTokenClientOptions — Interface; entry .. Public TypeScript interface AccountTokenClientOptions.
  • AccountTokenContext — Interface; entry .. Public TypeScript interface AccountTokenContext.
  • AccountTokenLock — Interface; entry .. Serialize every use of one Account Token: rotation invalidates the one replaced (PAP §4.8).
  • AccountTokenLocks — Const; entry .. Public TypeScript const AccountTokenLocks.
  • AgentDescriptor — Interface; entry .. Public TypeScript interface AgentDescriptor.
  • AgentIdentityClient — Class; entry .. Safely retrieve and bind a personal agent's public identity documents.
  • AgentIdentityClientOptions — Interface; entry .. Public TypeScript interface AgentIdentityClientOptions.
  • AgentProtocol — Interface; entry .. Public TypeScript interface AgentProtocol.
  • ApiCallOptions — Interface; entry .. Public TypeScript interface ApiCallOptions.
  • ApiClient — Class; entry .. Read and change through a company's API, the credentials host-owned.
  • ApiClientOptions — Interface; entry .. Public TypeScript interface ApiClientOptions.
  • ApiDescriptor — Interface; entry .. Public TypeScript interface ApiDescriptor.
  • ApiError — Class; entry .. The company refused an API call; code is its error, never its body.
  • ApiResponse — Interface; entry .. A successful API answer: the body, or the operation it proposes (202).
  • approve — Value; entry .. Public TypeScript value approve.
  • AuthCapabilities — Interface; entry .. Public TypeScript interface AuthCapabilities.
  • AuthorizationCodeGrant — Class; entry .. Public TypeScript class AuthorizationCodeGrant.
  • AuthorizationCodeGrantOptions — Interface; entry .. Public TypeScript interface AuthorizationCodeGrantOptions.
  • AuthorizationError — Class; entry .. Public TypeScript class AuthorizationError.
  • AuthorizationStateStore — Interface; entry .. Public TypeScript interface AuthorizationStateStore.
  • AuthorizationStateStores — Const; entry .. Public TypeScript const AuthorizationStateStores.
  • BROWSER_ASSERTION_TYPE — Const; entry .. Public TypeScript const BROWSER_ASSERTION_TYPE.
  • BrowserAssertionClaims — Interface; entry .. Public TypeScript interface BrowserAssertionClaims.
  • BrowserAssertionOptions — Interface; entry .. Public TypeScript interface BrowserAssertionOptions.
  • BrowserFormPost — Interface; entry .. Public TypeScript interface BrowserFormPost.
  • BrowserFormPosts — Const; entry .. Public TypeScript const BrowserFormPosts.
  • BrowserHandoff — Interface; entry .. Public TypeScript interface BrowserHandoff.
  • BrowserHandoffs — Const; entry .. Public TypeScript const BrowserHandoffs.
  • BrowserSessionClient — Class; entry .. Public TypeScript class BrowserSessionClient.
  • BrowserSessionError — Class; entry .. Public TypeScript class BrowserSessionError.
  • BrowserSessionStart — Interface; entry .. Public TypeScript interface BrowserSessionStart.
  • budgetKey — Function; entry .. The shared rate-limit budget a request draws on: its company's origin.
  • buildBrowserAssertionClaims — Function; entry .. Public TypeScript function buildBrowserAssertionClaims.
  • buildDirectSignInRequest — Value; entry .. Public TypeScript value buildDirectSignInRequest.
  • buildPapReactor — Function; entry .. Public TypeScript function buildPapReactor.
  • buildSessionAssertionClaims — Function; entry .. Public TypeScript function buildSessionAssertionClaims.
  • CacheBounds — Interface; entry .. How long metadata may be cached, whatever its Cache-Control says.
  • CachedMetadata — Interface; entry .. One cached metadata document: the parsed JSON, where it came from, until when.
  • cacheLifetime — Function; entry .. Seconds to keep a response by its Cache-Control, or undefined when it must not be cached.
  • Caches — Const; entry .. Public TypeScript const Caches.
  • ClientMetadata — Interface; entry .. Public TypeScript interface ClientMetadata.
  • Clock — Interface; entry .. Public TypeScript interface Clock.
  • Clocks — Const; entry .. Public TypeScript const Clocks.
  • ConfirmOptions — Interface; entry .. Public TypeScript interface ConfirmOptions.
  • ConfirmOutcome — Interface; entry .. Public TypeScript interface ConfirmOutcome.
  • ConversationClient — Class; entry .. Start and continue PAP conversations through a proof-bound transport.
  • ConversationClientOptions — Interface; entry .. Public TypeScript interface ConversationClientOptions.
  • conversationEndpoint — Function; entry .. The poppy conversation endpoint, skipping protocol types this SDK does not speak.
  • ConversationError — Class; entry .. Public TypeScript class ConversationError.
  • ConversationEvent — Interface; entry .. Public TypeScript interface ConversationEvent.
  • ConversationEventOptions — Interface; entry .. Public TypeScript interface ConversationEventOptions.
  • ConversationEventPage — Interface; entry .. Public TypeScript interface ConversationEventPage.
  • ConversationReceipt — Interface; entry .. Public TypeScript interface ConversationReceipt.
  • ConversationRequestOptions — Interface; entry .. Public TypeScript interface ConversationRequestOptions.
  • ConversationResponder — Type; entry .. Public TypeScript type ConversationResponder.
  • ConversationResponse — Type; entry .. Public TypeScript type ConversationResponse.
  • ConversationStatus — Type; entry .. Public TypeScript type ConversationStatus.
  • ConversationStreamOptions — Interface; entry .. Public TypeScript interface ConversationStreamOptions.
  • covers — Function; entry .. Whether a standing permission covers this revision, term by term.
  • createPapCorePlugin — Function; entry .. Public TypeScript function createPapCorePlugin.
  • DEFAULT_CACHE_BOUNDS — Const; entry .. At least a minute, at most a day (the Guides' example bounds).
  • DEVICE_CODE_GRANT — Const; entry .. Public TypeScript const DEVICE_CODE_GRANT.
  • DeviceSignInBeginOptions — Interface; entry .. Public TypeScript interface DeviceSignInBeginOptions.
  • DeviceSignInClient — Class; entry .. PAP Device Sign-In with private device codes and Reactor-backed Account Tokens.
  • DeviceSignInClientOptions — Interface; entry .. Public TypeScript interface DeviceSignInClientOptions.
  • DeviceSignInPoll — Interface; entry .. Public TypeScript interface DeviceSignInPoll.
  • DeviceSignInStart — Interface; entry .. Public TypeScript interface DeviceSignInStart.
  • DirectSignInBeginOptions — Interface; entry .. Public TypeScript interface DirectSignInBeginOptions.
  • DirectSignInCallback — Interface; entry .. Public TypeScript interface DirectSignInCallback.
  • DirectSignInClient — Class; entry .. Orchestrate one-use browser authorization and proof-bound code exchange.
  • DirectSignInClientOptions — Interface; entry .. Public TypeScript interface DirectSignInClientOptions.
  • DirectSignInCompleteOptions — Interface; entry .. Public TypeScript interface DirectSignInCompleteOptions.
  • DirectSignInOptions — Interface; entry .. Public TypeScript interface DirectSignInOptions.
  • DirectSignInRequest — Interface; entry .. Public TypeScript interface DirectSignInRequest.
  • DirectSignInResult — Interface; entry .. The signed-in Session, its scopes, and a reference to its stored Account Token.
  • DirectSignInStart — Interface; entry .. Public TypeScript interface DirectSignInStart.
  • discoverCompany — Function; entry .. Public TypeScript function discoverCompany.
  • DiscoveredCompany — Interface; entry .. Public TypeScript interface DiscoveredCompany.
  • DiscoveryDocument — Interface; entry .. Public TypeScript interface DiscoveryDocument.
  • DiscoveryError — Class; entry .. Public TypeScript class DiscoveryError.
  • DiscoveryOptions — Interface; entry .. Public TypeScript interface DiscoveryOptions.
  • DiscoveryTransport — Interface; entry .. Public TypeScript interface DiscoveryTransport.
  • DiscoveryTransports — Const; entry .. Public TypeScript const DiscoveryTransports.
  • DisplayLike — Type; entry .. Anything shaped like a display: Reactor's Display, or a tool result's _meta["reactor.ui/display"].
  • DpopFetchClient — Class; entry .. Send proof-bound PAP requests with fresh proofs and safe redirect handling.
  • DpopFetchClientOptions — Interface; entry .. Public TypeScript interface DpopFetchClientOptions.
  • DpopFetchRequestOptions — Interface; entry .. Public TypeScript interface DpopFetchRequestOptions.
  • DpopKeyMaterial — Interface; entry .. Public TypeScript interface DpopKeyMaterial.
  • DpopKeyResolver — Type; entry .. Public TypeScript type DpopKeyResolver.
  • DpopProofProvider — Interface; entry .. Public TypeScript interface DpopProofProvider.
  • DpopProofProviders — Const; entry .. Public TypeScript const DpopProofProviders.
  • DpopProofRequest — Interface; entry .. Public TypeScript interface DpopProofRequest.
  • ExtensionDescriptor — Interface; entry .. Public TypeScript interface ExtensionDescriptor.
  • extensionDomain — Function; entry .. The domain a third-party extension name is under, else undefined.
  • extensionNameKind — Function; entry .. plain for a protocol-defined name, third-party for domain/name, else invalid.
  • extensionRequired — Function; entry .. The extension a 403 extension_required names, else undefined.
  • firstContribution — Function; entry .. Public TypeScript function firstContribution.
  • generateMessageId — Function; entry .. Generate a user-global message ID with at least 128 random bits.
  • generatePairwiseUserId — Function; entry .. Public TypeScript function generatePairwiseUserId.
  • IdentityError — Class; entry .. Public TypeScript class IdentityError.
  • IdentityRequestOptions — Interface; entry .. Public TypeScript interface IdentityRequestOptions.
  • InMemoryProtocolCache — Class; entry .. Default pap.cache: a bounded, least-recently-used map in one process.
  • InMemoryStandingPermissionStore — Class; entry .. A single-process store of standing permissions, for examples and tests.
  • InProcessAccountTokenLock — Class; entry .. One in-process lock per reference: the default Account Token lock.
  • isPapConfirm — Function; entry .. Whether a display is an operation to confirm, of the version this SDK reads.
  • isPapConfirmData — Function; entry .. Whether a value is an operation to confirm's data, as PapConfirm sends
  • isPapOutcome — Function; entry .. Whether a display is what a confirmed operation came to, of the version this SDK reads.
  • isPapOutcomeData — Function; entry .. Whether a value is an outcome's data, as PapOutcome sends it: every
  • isPapSessionShown — Function; entry .. Whether a value is a PapSessionShown: a 12-hex-digit reference and signed_in, nothing else.
  • JoseAlgorithm — Type; entry .. Public TypeScript type JoseAlgorithm.
  • JoseDpopProofProvider — Class; entry .. Create fresh RFC 9449 proofs using per-user/company key material.
  • JoseDpopProofProviderOptions — Interface; entry .. Public TypeScript interface JoseDpopProofProviderOptions.
  • JsonWebKey — Interface; entry .. Public TypeScript interface JsonWebKey.
  • JsonWebKeySet — Interface; entry .. Public TypeScript interface JsonWebKeySet.
  • JwksRequestOptions — Interface; entry .. Public TypeScript interface JwksRequestOptions.
  • JWT_BEARER_GRANT — Const; entry .. Public TypeScript const JWT_BEARER_GRANT.
  • JWT_CLIENT_ASSERTION — Const; entry .. Public TypeScript const JWT_CLIENT_ASSERTION.
  • KNOWN_API_TYPES — Const; entry .. The API types this SDK speaks.
  • knownApis — Function; entry .. The advertised APIs of a type this SDK speaks, in the company's order.
  • MCP_PROTOCOL_VERSION — Const; entry .. Public TypeScript const MCP_PROTOCOL_VERSION.
  • mcpApi — Function; entry .. The company's MCP server, when it lists one.
  • McpBearerAuth — Class; entry .. Send a Bearer Session Token to one MCP server's URL, and nowhere else.
  • McpBearerOptions — Interface; entry .. Public TypeScript interface McpBearerOptions.
  • McpClient — Class; entry .. Initialize, list, and call tools on one MCP server with a resource-bound Bearer token.
  • McpClientOptions — Interface; entry .. Public TypeScript interface McpClientOptions.
  • McpError — Class; entry .. The MCP server refused a request; code is its token or JSON-RPC error.
  • McpToolResult — Interface; entry .. A tool's answer; operation is set when it proposed one (Operations §4.2).
  • MediatedCodeOptions — Interface; entry .. Public TypeScript interface MediatedCodeOptions.
  • MediatedField — Interface; entry .. PAP Mediated Sign-In: the user's credentials, relayed to one endpoint (§4.7).
  • MediatedSignInClient — Class; entry .. Relay a user's credentials to the company's mediated endpoint, once.
  • MediatedSignInClientOptions — Interface; entry .. Public TypeScript interface MediatedSignInClientOptions.
  • MediatedSignInDescriptor — Interface; entry .. Public TypeScript interface MediatedSignInDescriptor.
  • MediatedSignInOptions — Interface; entry .. Public TypeScript interface MediatedSignInOptions.
  • MediatedSignInResult — Interface; entry .. Public TypeScript interface MediatedSignInResult.
  • Message — Interface; entry .. Public TypeScript interface Message.
  • MetadataCache — Class; entry .. Public TypeScript class MetadataCache.
  • negotiateExtensions — Function; entry .. The extensions both sides list, at the same major version, that this host supports.
  • OAuthServerMetadata — Interface; entry .. Public TypeScript interface OAuthServerMetadata.
  • openapiUrl — Function; entry .. The company's OpenAPI description, when it advertises one.
  • openTelemetrySink — Function; entry .. pap.telemetry as OpenTelemetry spans: one per event, from tracer (for example
  • OpenTelemetryTracer — Interface; entry .. The part of an OpenTelemetry API Tracer the adapter uses.
  • Operation — Interface; entry .. Public TypeScript interface Operation.
  • OperationConfirmation — Interface; entry .. Public TypeScript interface OperationConfirmation.
  • OperationError — Class; entry .. Public TypeScript class OperationError.
  • operationFrom — Function; entry .. The one operation object, from whichever channel carried it (Operations §4).
  • operationPage — Function; entry .. The operation's url, once checked to be the company's own HTTPS page (§4.4, §5).
  • OperationRequestOptions — Interface; entry .. Public TypeScript interface OperationRequestOptions.
  • OperationResult — Interface; entry .. Public TypeScript interface OperationResult.
  • OPERATIONS_EXTENSION — Const; entry .. PAP Operations extension v1 on the personal agent's side, as in Python:
  • OPERATIONS_VERSION — Const; entry .. Public TypeScript const OPERATIONS_VERSION.
  • OperationsClient — Class; entry .. Read, confirm, and cancel operations at a negotiated endpoint.
  • OperationsClientOptions — Interface; entry .. Public TypeScript interface OperationsClientOptions.
  • operationsEndpoint — Function; entry .. The company's operations endpoint when both sides list version 1.
  • OperationState — Type; entry .. Public TypeScript type OperationState.
  • optionalContribution — Function; entry .. The highest-priority provider for an optional PAP point, undefined when there is none.
  • Organization — Interface; entry .. Public TypeScript interface Organization.
  • PairwiseUserIdStore — Interface; entry .. Public TypeScript interface PairwiseUserIdStore.
  • PairwiseUserIdStores — Const; entry .. Public TypeScript const PairwiseUserIdStores.
  • PAP_ACTION_CLASSES — Const; entry .. Every PapActionClass, in the Rules' order.
  • PAP_CONFIRM_TYPE — Const; entry .. The display type of an operation waiting for the person to confirm it.
  • PAP_CONFIRM_VERSION — Const; entry .. The version of PAP_CONFIRM_TYPE this module reads.
  • PAP_OUTCOME_STATES — Const; entry .. Every PapOutcomeState.
  • PAP_OUTCOME_TYPE — Const; entry .. The display type of what a confirmed operation came to.
  • PAP_OUTCOME_VERSION — Const; entry .. The version of PAP_OUTCOME_TYPE this module reads.
  • PapActionClass — Type; entry .. What confirming an operation does, as an application's Rules class it.
  • PapConfirmData — Type; entry .. An operation to confirm, as a display's data (PapConfirm's fields).
  • papConfirmDisplay — Function; entry .. An operation to confirm as its display, text included; throws when data is not one.
  • PapConfirmDisplay — Type; entry .. A display of an operation to confirm, as the page receives it.
  • papConfirmText — Function; entry .. What an operation to confirm reads as without a renderer: PapConfirm.text(), word for word.
  • PapCoreOptions — Interface; entry .. Public TypeScript interface PapCoreOptions.
  • PapOutcomeData — Type; entry .. What a confirmed operation came to, as a display's data (PapOutcome's fields).
  • papOutcomeDisplay — Function; entry .. An outcome as its display, text included; throws when data is not one.
  • PapOutcomeDisplay — Type; entry .. A display of what a confirmed operation came to, as the page receives it.
  • PapOutcomeState — Type; entry .. What a confirmed operation came to: every operation state but proposed.
  • papOutcomeText — Function; entry .. What an outcome reads as without a renderer: PapOutcome.text(), word for word.
  • PapSessionShown — Type; entry .. The Session an operation is confirmed in: a one-way reference (12 hex
  • PapTermsWas — Type; entry .. The revision a revised operation replaced, and its terms.
  • parseClientMetadata — Function; entry .. Public TypeScript function parseClientMetadata.
  • parseConversationEvent — Function; entry .. Public TypeScript function parseConversationEvent.
  • parseConversationEventPage — Function; entry .. Public TypeScript function parseConversationEventPage.
  • parseDiscoveryDocument — Function; entry .. Public TypeScript function parseDiscoveryDocument.
  • parseJsonStrict — Function; entry .. Parse JSON while rejecting duplicate object member names at every depth.
  • parseJsonWebKeySet — Function; entry .. Public TypeScript function parseJsonWebKeySet.
  • parseMessage — Function; entry .. Public TypeScript function parseMessage.
  • parseOAuthServerMetadata — Function; entry .. Public TypeScript function parseOAuthServerMetadata.
  • parseOperation — Function; entry .. Public TypeScript function parseOperation.
  • parseRetryAfter — Function; entry .. Retry-After in seconds (delta-seconds or an HTTP date), or undefined.
  • parseSessionToken — Function; entry .. Public TypeScript function parseSessionToken.
  • PersonalAgentProtocolError — Class; entry .. Safe base error for Personal Agent Protocol failures.
  • ProofError — Class; entry .. Public TypeScript class ProofError.
  • ProtectedInput — Interface; entry .. The host's trusted input surface: answers never pass through a model.
  • ProtectedInputField — Interface; entry .. Public TypeScript interface ProtectedInputField.
  • ProtectedInputRequest — Interface; entry .. What the host must ask the user for, outside any model (PAP §4.7).
  • ProtectedInputs — Const; entry .. Public TypeScript const ProtectedInputs.
  • PROTOCOL_PROFILE — Const; entry .. The Personal Agent Protocol draft implemented.
  • PROTOCOL_REVISION — Const; entry .. The upstream specification revision (its page date) the draft was implemented from.
  • ProtocolCache — Interface; entry .. Public TypeScript interface ProtocolCache.
  • ProtocolValidationError — Class; entry .. Public TypeScript class ProtocolValidationError.
  • RandomBytes — Type; entry .. Public TypeScript type RandomBytes.
  • RandomSource — Interface; entry .. Public TypeScript interface RandomSource.
  • RandomSources — Const; entry .. Public TypeScript const RandomSources.
  • RateLimitBudget — Interface; entry .. A company's request budget, shared by every task and user of the host.
  • RateLimitBudgets — Const; entry .. Public TypeScript const RateLimitBudgets.
  • RecordingTelemetrySink — Class; entry .. pap.telemetry in memory: every event, in order.
  • REFRESH_TOKEN_GRANT — Const; entry .. PAP Account Tokens: refresh, rotation, narrowing, and revocation (§4.8, §4.9).
  • resolvePairwiseUserId — Value; entry .. Public TypeScript value resolvePairwiseUserId.
  • RetryPolicies — Const; entry .. Public TypeScript const RetryPolicies.
  • RetryPolicy — Class; entry .. When to retry a refused request (Guides, retries).
  • safeAttributes — Function; entry .. The allowlisted attributes of values; undefined and failing values are dropped.
  • SecretValue — Class; entry .. Redacted wrapper for credentials and other protocol secrets.
  • SessionAssertionClaims — Interface; entry .. Public TypeScript interface SessionAssertionClaims.
  • SessionAssertionOptions — Interface; entry .. Public TypeScript interface SessionAssertionOptions.
  • SessionClient — Class; entry .. Start and renew signed-out PAP sessions over an OAuth token endpoint.
  • SessionClientOptions — Interface; entry .. Public TypeScript interface SessionClientOptions.
  • SessionError — Class; entry .. Public TypeScript class SessionError.
  • SessionGrant — Class; entry .. Public TypeScript class SessionGrant.
  • SessionGrantOptions — Interface; entry .. Public TypeScript interface SessionGrantOptions.
  • SessionRenewOptions — Interface; entry .. Public TypeScript interface SessionRenewOptions.
  • SessionRequestOptions — Interface; entry .. Public TypeScript interface SessionRequestOptions.
  • SessionToken — Interface; entry .. Public TypeScript interface SessionToken.
  • SharedRateLimitBudget — Class; entry .. Default pap.rateLimitBudget: per-company budgets in one process.
  • Signer — Interface; entry .. Public TypeScript interface Signer.
  • Signers — Const; entry .. Public TypeScript const Signers.
  • StandingPermission — Interface; entry .. Public TypeScript interface StandingPermission.
  • StandingPermissionRequest — Interface; entry .. Public TypeScript interface StandingPermissionRequest.
  • StandingPermissionStore — Interface; entry .. Reserve, commit, and release uses of the user's standing permissions.
  • StandingPermissionStores — Value; entry .. Public TypeScript value StandingPermissionStores.
  • StartConversationOptions — Interface; entry .. Public TypeScript interface StartConversationOptions.
  • StreamItem — Type; entry .. Public TypeScript type StreamItem.
  • StreamReconnected — Interface; entry .. The stream was reopened from Last-Event-ID; drop the partial messages named.
  • SUPPORTED_EXTENSIONS — Const; entry .. Extensions this SDK implements, by name and major version.
  • TELEMETRY_ATTRIBUTES — Const; entry .. The only attribute names an event may carry, each with the rule its value must pass.
  • TELEMETRY_EVENTS — Const; entry .. Every event the SDK emits, and its stage.
  • TELEMETRY_STAGES — Const; entry .. Public TypeScript const TELEMETRY_STAGES.
  • TelemetryAttributes — Type; entry .. Public TypeScript type TelemetryAttributes.
  • TelemetryEvent — Class; entry .. One finished protocol stage: a span for traces, an event for analytics.
  • TelemetrySink — Interface; entry .. Receive each finished protocol stage (TelemetryEvent of telemetry.ts), redacted already.
  • TelemetrySinks — Const; entry .. TelemetrySink: where traces and analytics events go; none, and nothing is emitted.
  • TelemetryStage — Type; entry .. Public TypeScript type TelemetryStage.
  • TelemetryValue — Type; entry .. Public TypeScript type TelemetryValue.
  • TermLimit — Interface; entry .. Public TypeScript interface TermLimit.
  • termsDigest — Value; entry .. Public TypeScript value termsDigest.
  • TextDelta — Interface; entry .. A piece of a message still being written (SSE text-delta, §7.6): for
  • TokenStore — Interface; entry .. Public TypeScript interface TokenStore.
  • TokenStores — Const; entry .. Public TypeScript const TokenStores.
  • TransportError — Class; entry .. Public TypeScript class TransportError.
  • UrlSafetyPolicies — Const; entry .. Public TypeScript const UrlSafetyPolicies.
  • UrlSafetyPolicy — Interface; entry .. Public TypeScript interface UrlSafetyPolicy.
  • UserApproval — Interface; entry .. Public TypeScript interface UserApproval.
  • validateDirectSignInCallback — Function; entry .. Public TypeScript function validateDirectSignInCallback.
  • WebDescriptor — Interface; entry .. Public TypeScript interface WebDescriptor.
  • BrowserAssertionReplayCache — Interface; entry ./server. Public TypeScript interface BrowserAssertionReplayCache.
  • createResolvingFetch — Function; entry ./server. A fetch that resolves, vets, and pins: dns.lookup every address of the host, refuse
  • DpopReplayCache — Interface; entry ./server. Public TypeScript interface DpopReplayCache.
  • isGlobalAddress — Function; entry ./server. Whether a textual IP address is global unicast: never loopback, private, link-local,
  • JoseSigner — Class; entry ./server. Sign PAP assertions with an injected asymmetric private key or handle.
  • JoseSignerOptions — Interface; entry ./server. Public TypeScript interface JoseSignerOptions.
  • NodeAddressResolver — Type; entry ./server. Every address a host name resolves to (A and AAAA).
  • NodeUrlSafetyPolicy — Class; entry ./server. DNS-aware server policy for untrusted PAP discovery and metadata URLs: every address
  • NodeUrlSafetyPolicyOptions — Interface; entry ./server. Public TypeScript interface NodeUrlSafetyPolicyOptions.
  • resolveAddresses — Value; entry ./server. Public TypeScript value resolveAddresses.
  • ResolvingFetchOptions — Interface; entry ./server. Public TypeScript interface ResolvingFetchOptions.
  • VerifiedBrowserAssertion — Interface; entry ./server. Public TypeScript interface VerifiedBrowserAssertion.
  • VerifiedDpopProof — Interface; entry ./server. Public TypeScript interface VerifiedDpopProof.
  • verifyBrowserAssertion — Value; entry ./server. Public TypeScript value verifyBrowserAssertion.
  • VerifyBrowserAssertionOptions — Interface; entry ./server. Public TypeScript interface VerifyBrowserAssertionOptions.
  • verifyDpopProof — Value; entry ./server. Public TypeScript value verifyDpopProof.
  • VerifyDpopProofOptions — Interface; entry ./server. Public TypeScript interface VerifyDpopProofOptions.
  • vetHost — Value; entry ./server. Public TypeScript value vetHost.