@openagentid/oas-vanilla/sdk

All packages · Runnable examples · Start an agent

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.

Exports

• CreatedIdentity
• createHmr
• createMhr
• createRootWithKeypair

CreatedIdentity

The result of creating a new root identity.

Contains the signed identity document and the keypair used to sign it. The caller is responsible for securely storing the keypair.

declare class CreatedIdentity {
  constructor(document: OasDocument, keypair: OasKeyPair);
  document: OasDocument;
  keypair: OasKeyPair;
  toString(): string;
  toJSON(): object;
}

Source: @openagentid/oas-vanilla@1.0.2, src/sdk/identity.js:15.

createHmr

Creates a new Human Root (HMR) identity.

Generates a fresh Ed25519 keypair, constructs an OAS Identity Document for a did:oas:<namespace>:hmr:<identifier> DID, and signs it.

declare function createHmr(namespace: string, identifier: string, created: string): Promise<CreatedIdentity>;

Source: @openagentid/oas-vanilla@1.0.2, src/sdk/identity.js:63.

throws: {OasError} If DID construction or document building fails.

createMhr

Creates a new Multi-Human Root (MHR) identity.

Similar to createHmr but for machine-originated root entities.

declare function createMhr(namespace: string, identifier: string, created: string): Promise<CreatedIdentity>;

Source: @openagentid/oas-vanilla@1.0.2, src/sdk/identity.js:99.

throws: {OasError}

createRootWithKeypair

Creates a new root identity with a pre-existing keypair.

declare function createRootWithKeypair(namespace: string, kind: string, identifier: string, keypair: OasKeyPair, created: string): Promise<import("../document/document.js").OasDocument>;

Source: @openagentid/oas-vanilla@1.0.2, src/sdk/identity.js:135.

throws: {OasError}

Package requirements

This version declares no dependencies or peer dependencies.

Archive verification

Pinned integrity:

sha512-66sPTWDxCcQ55S9YvPbk4BxF8c92CNqAHOUv7jp1uC+3ygYzZKf5dbvK2/rQwvhP+3oi7T3n1Zn1K1PK99zvMQ==

Machine-readable API manifest · Coverage