OpenAgentIDDocumentation
API referencenpm packages@openagentid/oas-vanilla
OpenAgentIDAPI reference

@openagentid/oas-vanilla/resolve

API contract shipped by @openagentid/oas-vanilla 1.0.2. Exact exports, signatures, dependencies and availability.

All packages · Runnable examples · Start an agent

ContractValue
Package@openagentid/oas-vanilla@1.0.2
Entry point@openagentid/oas-vanilla/resolve
AvailabilityPublished package
Reference sourcePublished JavaScript and JSDoc (inferred types)
Package enginesnode >=20.0.0

Before integrating

Publishes JavaScript with JSDoc, not TypeScript declarations. Inferred signatures are labeled separately.

This reference is generated from the integrity-verified npm archive for this exact version. Signatures describe the public contract; they are not standalone programs. Complete examples are checked separately.

This package ships JavaScript with JSDoc, not .d.ts files. The signatures below are inferred from that published source. An inferred any reflects missing type information in the package.

Import conditions

Use the public entry point above. The package resolves it to these shipped files; do not import its internal files directly.

ConditionPublished file
default./src/resolve/resolver.js

Exports

Resolver

A resolver that resolves did:oas identifiers to OasDocuments.

This is the abstract interface. Implementations provide actual resolution logic (in-memory, HTTP, DHT, etc.).

Type-only declaration; it is not a runtime value.

Signature
type Resolver = { resolve: (did: string) => Promise<import("../document/document.js").OasDocument>; };

Source: @openagentid/oas-vanilla@1.0.2, src/resolve/resolver.js:10.

Supporting declarations

These package-owned declarations are referenced by the exports above. Their presence here does not make them importable from this entry point. Import only the names in Exports.

OasDocument

An OAS Identity Document as defined in OAS Specification §5.

This is the canonical representation of an autonomous entity's identity, extending the W3C DID Document with OAS-specific properties.

Signature
declare class OasDocument {
  constructor(fields: { context: string[]; id: string; controller: string; verificationMethod: VerificationMethod[]; authentication: string[]; assertionMethod?: string[]; capabilityInvocation?: string[]; capabilityDelegation?: string[]; service?: ServiceEndpoint[]; oasVersion: string; kind: string; name?: string | null; description?: string | null; lineage?: LineageSection | null; conformanceLevel: string; lifecycleStatus?: string | null; sequence: number; metadata: {    created: string;    updated?: string | null;    version?: string | null;}; proof?: DocumentProof | null; revoked?: boolean | null; revokedAt?: string | null; });
  static fromJSON(obj: object): OasDocument;
  context: string[];
  id: string;
  controller: string;
  verificationMethod: VerificationMethod[];
  authentication: string[];
  assertionMethod: string[];
  capabilityInvocation: string[];
  capabilityDelegation: string[];
  service: ServiceEndpoint[];
  oasVersion: string;
  kind: string;
  name: string;
  description: string;
  lineage: LineageSection;
  conformanceLevel: string;
  lifecycleStatus: string;
  sequence: number;
  metadata: { created: string; updated: string | null; version: string | null; };
  proof: DocumentProof;
  revoked: boolean;
  revokedAt: string;
  governance: GovernanceSection;
  profile: ProfileSection;
  contact: ContactSection;
  calendar: CalendarSection;
  operational: OperationalSection;
  pricing: PricingSection;
  interoperability: InteroperabilitySection;
  reputation: ReputationSection;
  compliance: ComplianceSection;
  relationships: RelationshipsSection;
  isRoot(): boolean;
  isRevoked(): boolean;
  canonicalDigest(): string;
  primaryPublicKeyMultibase(): string | null;
  findVerificationMethod(idOrFragment: string): VerificationMethod | null;
  toJSON(): object;
}

Source: @openagentid/oas-vanilla@1.0.2, src/document/document.js:66.

Package requirements

This version declares no dependencies or peer dependencies.

Archive verification

Pinned integrity:

SHA-512 integrity
sha512-66sPTWDxCcQ55S9YvPbk4BxF8c92CNqAHOUv7jp1uC+3ygYzZKf5dbvK2/rQwvhP+3oi7T3n1Zn1K1PK99zvMQ==

Machine-readable API manifest · Coverage

On this page