iso-did/dist/src/types.d.ts

Isomorphic did core and did key tooling

import type { ResolverOptions as _ResolverOptions, KeyCapabilitySection, ParsedDID, ResolverRegistry, Service } from 'did-resolver';
import type { Tagged } from 'type-fest';
import type { JWK } from './jwk-types';
import type { DIDKey } from './key';
import type { DIDPkh } from './pkh';
export type { KeyType, PublicKeyCode, SignatureAlgorithm } from './common';
export * from './jwk-types';
export interface ResolveOptions {
    resolvers?: ResolverRegistry;
    cache?: _ResolverOptions['cache'];
}
/**
 * DID Types
 */
/**
 * DID string
 */
export type DID = Tagged<`did:${string}:${string}`, 'DID'>;
/**
 * DID URL string
 */
export type DIDURL = Tagged<string, 'DIDURL'>;
/**
 * Represents a DID URL object.
 */
export interface DIDURLObject extends Omit<ParsedDID, 'params'> {
    /**
     * DID String - top level DID
     * @example "did:web:example.com"
     */
    did: DID;
    /**
     * DID URL string
     * @example "did:web:example.com#fragment1?query=value"
     */
    didUrl: DIDURL;
}
/**
 * @see https://www.iana.org/assignments/cose/cose.xhtml#algorithms
 * @see https://www.rfc-editor.org/rfc/rfc7518#section-3.1
 */
/**
 * Represents the properties of a Verification Method listed in a DID document.
 *
 * This data type includes public key representations that are no longer present in the spec but are still used by
 * several DID methods / resolvers and kept for backward compatibility.
 *
 * @see {@link https://www.w3.org/TR/cid-1.0/#verification-methods}
 */
export type VerificationMethod = MultiKeyMethod | JsonWebKeyMethod | EcdsaSecp256k1RecoveryMethod2020;
/**
 * @see {@link https://www.w3.org/TR/cid-1.0/#dfn-verificationmethod}
 */
export interface VerificationMethodBase {
    id: DIDURL;
    controller: DID;
    /**
     * ISO date time string
     * @see {@link https://www.w3.org/TR/xmlschema11-2/#dateTimeStamp}
     * @example "2024-12-10T15:28:32Z"
     */
    expires?: string;
    /**
     * ISO date time string
     * @see {@link https://www.w3.org/TR/xmlschema11-2/#dateTimeStamp}
     * @example "2024-12-10T15:28:32Z"
     */
    revoked?: string;
}
/**
 * @see https://www.w3.org/TR/cid-1.0/#Multikey
 */
export interface MultiKeyMethod extends VerificationMethodBase {
    type: 'MultiKey' | 'Multikey';
    publicKeyMultibase: string;
}
/**
 * @see https://www.w3.org/TR/cid-1.0/#JsonWebKey
 */
export interface JsonWebKeyMethod extends VerificationMethodBase {
    type: 'JsonWebKey2020' | 'JsonWebKey';
    publicKeyJwk: JWK;
}
/**
 * @see https://identity.foundation/EcdsaSecp256k1RecoverySignature2020/#blockchainAccountId
 */
export interface EcdsaSecp256k1RecoveryMethod2020 extends VerificationMethodBase {
    type: 'EcdsaSecp256k1RecoveryMethod2020';
    blockchainAccountId: string;
}
/**
 * Represents a DID document.
 *
 * @see {@link https://www.w3.org/TR/did-core/#did-document-properties}
 */
export type DIDDocument = {
    '@context'?: 'https://www.w3.org/ns/did/v1' | string | string[];
    id: string;
    alsoKnownAs?: string[];
    controller?: string | string[];
    verificationMethod?: VerificationMethod[];
    service?: Service[];
} & {
    [x in KeyCapabilitySection]?: Array<string | VerificationMethod>;
};
export interface VerifiableDID extends DIDURLObject {
    /**
     * Verifiable DID - resolved from the {@link did}
     */
    verifiableDid: DIDKey | DIDPkh;
    /**
     * DID Document
     */
    document: DIDDocument;
    /**
     * DID URL Object
     */
    didObject: DIDURLObject;
    /**
     * Returns the DID URL
     */
    toString: () => DIDURL;
}
export interface VerifiableDidOptions {
    verifiableDid: DIDKey | DIDPkh;
    document: DIDDocument;
    didObject: DIDURLObject;
}
//# sourceMappingURL=types.d.ts.map