@didcid/keymaster 0.1.3

package/dist/types/keymaster.d.ts

@@ -0,0 +1,211 @@
+import { DidCidDocument, ResolveDIDOptions, Operation } from '@didcid/gatekeeper/types';
+import { Challenge, ChallengeResponse, CheckWalletResult, CreateAssetOptions, FileAssetOptions, CreateResponseOptions, DmailItem, DmailMessage, EncryptOptions, FileAsset, FixWalletResult, Group, GroupVault, GroupVaultOptions, IDInfo, ImageAsset, IssueCredentialsOptions, KeymasterInterface, KeymasterOptions, NoticeMessage, Poll, PossiblySigned, Signature, StoredWallet, VerifiableCredential, ViewPollResult, WalletFile, WalletEncFile } from '@didcid/keymaster/types';
+import { EcdsaJwkPair, EcdsaJwkPublic } from '@didcid/cipher/types';
+export declare enum DmailTags {
+    DMAIL = "dmail",
+    INBOX = "inbox",
+    DRAFT = "draft",
+    SENT = "sent",
+    ARCHIVED = "archived",
+    DELETED = "deleted",
+    UNREAD = "unread"
+}
+export declare enum NoticeTags {
+    DMAIL = "dmail",
+    BALLOT = "ballot",
+    POLL = "poll",
+    CREDENTIAL = "credential"
+}
+export default class Keymaster implements KeymasterInterface {
+    private readonly passphrase;
+    private gatekeeper;
+    private db;
+    private cipher;
+    private searchEngine;
+    private readonly defaultRegistry;
+    private readonly ephemeralRegistry;
+    private readonly maxNameLength;
+    private readonly maxDataLength;
+    private _walletCache?;
+    private _hdkeyCache?;
+    constructor(options: KeymasterOptions);
+    listRegistries(): Promise<string[]>;
+    private mutateWallet;
+    loadWallet(): Promise<WalletFile>;
+    saveWallet(wallet: StoredWallet, overwrite?: boolean): Promise<boolean>;
+    newWallet(mnemonic?: string, overwrite?: boolean): Promise<WalletFile>;
+    decryptMnemonic(): Promise<string>;
+    getMnemonicForDerivation(wallet: WalletFile): Promise<string>;
+    checkWallet(): Promise<CheckWalletResult>;
+    fixWallet(): Promise<FixWalletResult>;
+    resolveSeedBank(): Promise<DidCidDocument>;
+    updateSeedBank(doc: DidCidDocument): Promise<boolean>;
+    backupWallet(registry?: string, wallet?: WalletFile): Promise<string>;
+    recoverWallet(did?: string): Promise<WalletFile>;
+    listIds(): Promise<string[]>;
+    getCurrentId(): Promise<string | undefined>;
+    setCurrentId(name: string): Promise<boolean>;
+    didMatch(did1: string, did2: string): boolean;
+    fetchIdInfo(id?: string, wallet?: WalletFile): Promise<IDInfo>;
+    hdKeyPair(): Promise<EcdsaJwkPair>;
+    getPublicKeyJwk(doc: DidCidDocument): EcdsaJwkPublic;
+    fetchKeyPair(name?: string): Promise<EcdsaJwkPair | null>;
+    createAsset(data: unknown, options?: CreateAssetOptions): Promise<string>;
+    cloneAsset(id: string, options?: CreateAssetOptions): Promise<string>;
+    generateImageAsset(buffer: Buffer): Promise<ImageAsset>;
+    createImage(buffer: Buffer, options?: CreateAssetOptions): Promise<string>;
+    updateImage(id: string, buffer: Buffer): Promise<boolean>;
+    getImage(id: string): Promise<ImageAsset | null>;
+    testImage(id: string): Promise<boolean>;
+    getMimeType(buffer: Buffer): Promise<string>;
+    generateFileAsset(filename: string, buffer: Buffer): Promise<FileAsset>;
+    createDocument(buffer: Buffer, options?: FileAssetOptions): Promise<string>;
+    updateDocument(id: string, buffer: Buffer, options?: FileAssetOptions): Promise<boolean>;
+    getDocument(id: string): Promise<FileAsset | null>;
+    testDocument(id: string): Promise<boolean>;
+    encryptMessage(msg: string, receiver: string, options?: EncryptOptions): Promise<string>;
+    private decryptWithDerivedKeys;
+    decryptMessage(did: string): Promise<string>;
+    encryptJSON(json: unknown, did: string, options?: EncryptOptions): Promise<string>;
+    decryptJSON(did: string): Promise<unknown>;
+    addSignature<T extends object>(obj: T, controller?: string): Promise<T & {
+        signature: Signature;
+    }>;
+    verifySignature<T extends PossiblySigned>(obj: T): Promise<boolean>;
+    updateDID(id: string, doc: DidCidDocument): Promise<boolean>;
+    revokeDID(id: string): Promise<boolean>;
+    addToOwned(did: string, owner?: string): Promise<boolean>;
+    removeFromOwned(did: string, owner: string): Promise<boolean>;
+    addToHeld(did: string): Promise<boolean>;
+    removeFromHeld(did: string): Promise<boolean>;
+    lookupDID(name: string): Promise<string>;
+    resolveDID(did: string, options?: ResolveDIDOptions): Promise<DidCidDocument>;
+    idInWallet(did?: string): Promise<boolean>;
+    resolveAsset(did: string, options?: ResolveDIDOptions): Promise<any>;
+    updateAsset(did: string, data: Record<string, unknown>): Promise<boolean>;
+    transferAsset(id: string, controller: string): Promise<boolean>;
+    listAssets(owner?: string): Promise<string[]>;
+    validateName(name: string, wallet?: WalletFile): string;
+    createId(name: string, options?: {
+        registry?: string;
+    }): Promise<string>;
+    createIdOperation(name: string, account?: number, options?: {
+        registry?: string;
+    }): Promise<Operation>;
+    removeId(name: string): Promise<boolean>;
+    renameId(id: string, name: string): Promise<boolean>;
+    backupId(id?: string): Promise<boolean>;
+    recoverId(did: string): Promise<string>;
+    rotateKeys(): Promise<boolean>;
+    listNames(options?: {
+        includeIDs?: boolean;
+    }): Promise<Record<string, string>>;
+    addName(name: string, did: string): Promise<boolean>;
+    getName(name: string): Promise<string | null>;
+    removeName(name: string): Promise<boolean>;
+    testAgent(id: string): Promise<boolean>;
+    bindCredential(schemaId: string, subjectId: string, options?: {
+        validFrom?: string;
+        validUntil?: string;
+        credential?: Record<string, unknown>;
+    }): Promise<VerifiableCredential>;
+    issueCredential(credential: Partial<VerifiableCredential>, options?: IssueCredentialsOptions): Promise<string>;
+    sendCredential(did: string, options?: CreateAssetOptions): Promise<string | null>;
+    private isVerifiableCredential;
+    updateCredential(did: string, credential: VerifiableCredential): Promise<boolean>;
+    revokeCredential(credential: string): Promise<boolean>;
+    listIssued(issuer?: string): Promise<string[]>;
+    acceptCredential(did: string): Promise<boolean>;
+    getCredential(id: string): Promise<VerifiableCredential | null>;
+    removeCredential(id: string): Promise<boolean>;
+    listCredentials(id?: string): Promise<string[]>;
+    publishCredential(did: string, options?: {
+        reveal?: boolean;
+    }): Promise<VerifiableCredential>;
+    unpublishCredential(did: string): Promise<string>;
+    createChallenge(challenge?: Challenge, options?: CreateAssetOptions): Promise<string>;
+    private findMatchingCredential;
+    createResponse(challengeDID: string, options?: CreateResponseOptions): Promise<string>;
+    verifyResponse(responseDID: string, options?: {
+        retries?: number;
+        delay?: number;
+    }): Promise<ChallengeResponse>;
+    createGroup(name: string, options?: CreateAssetOptions): Promise<string>;
+    getGroup(id: string): Promise<Group | null>;
+    addGroupMember(groupId: string, memberId: string): Promise<boolean>;
+    removeGroupMember(groupId: string, memberId: string): Promise<boolean>;
+    testGroup(groupId: string, memberId?: string): Promise<boolean>;
+    listGroups(owner?: string): Promise<string[]>;
+    private validateSchema;
+    private generateSchema;
+    createSchema(schema?: unknown, options?: CreateAssetOptions): Promise<string>;
+    getSchema(id: string): Promise<unknown | null>;
+    setSchema(id: string, schema: unknown): Promise<boolean>;
+    testSchema(id: string): Promise<boolean>;
+    listSchemas(owner?: string): Promise<string[]>;
+    createTemplate(schemaId: string): Promise<Record<string, unknown>>;
+    pollTemplate(): Promise<Poll>;
+    createPoll(poll: Poll, options?: CreateAssetOptions): Promise<string>;
+    getPoll(id: string): Promise<Poll | null>;
+    testPoll(id: string): Promise<boolean>;
+    listPolls(owner?: string): Promise<string[]>;
+    viewPoll(pollId: string): Promise<ViewPollResult>;
+    votePoll(pollId: string, vote: number, options?: {
+        spoil?: boolean;
+        registry?: string;
+        validUntil?: string;
+    }): Promise<string>;
+    updatePoll(ballot: string): Promise<boolean>;
+    publishPoll(pollId: string, options?: {
+        reveal?: boolean;
+    }): Promise<boolean>;
+    unpublishPoll(pollId: string): Promise<boolean>;
+    createGroupVault(options?: GroupVaultOptions): Promise<string>;
+    getGroupVault(groupVaultId: string, options?: ResolveDIDOptions): Promise<GroupVault>;
+    testGroupVault(id: string, options?: ResolveDIDOptions): Promise<boolean>;
+    private generateSaltedId;
+    private decryptGroupVault;
+    private checkGroupVaultOwner;
+    private addMemberKey;
+    private checkVaultVersion;
+    getAgentDID(doc: DidCidDocument): string;
+    addGroupVaultMember(vaultId: string, memberId: string): Promise<boolean>;
+    removeGroupVaultMember(vaultId: string, memberId: string): Promise<boolean>;
+    listGroupVaultMembers(vaultId: string): Promise<Record<string, any>>;
+    addGroupVaultItem(vaultId: string, name: string, buffer: Buffer): Promise<boolean>;
+    removeGroupVaultItem(vaultId: string, name: string): Promise<boolean>;
+    listGroupVaultItems(vaultId: string, options?: ResolveDIDOptions): Promise<Record<string, any>>;
+    getGroupVaultItem(vaultId: string, name: string, options?: ResolveDIDOptions): Promise<Buffer | null>;
+    listDmail(): Promise<Record<string, DmailItem>>;
+    verifyTagList(tags: string[]): string[];
+    fileDmail(did: string, tags: string[]): Promise<boolean>;
+    removeDmail(did: string): Promise<boolean>;
+    verifyRecipientList(list: string[]): Promise<string[]>;
+    verifyDmail(message: DmailMessage): Promise<DmailMessage>;
+    createDmail(message: DmailMessage, options?: GroupVaultOptions): Promise<string>;
+    updateDmail(did: string, message: DmailMessage): Promise<boolean>;
+    sendDmail(did: string): Promise<string | null>;
+    getDmailMessage(did: string, options?: ResolveDIDOptions): Promise<DmailMessage | null>;
+    listDmailAttachments(did: string, options?: ResolveDIDOptions): Promise<Record<string, any>>;
+    addDmailAttachment(did: string, name: string, buffer: Buffer): Promise<boolean>;
+    removeDmailAttachment(did: string, name: string): Promise<boolean>;
+    getDmailAttachment(did: string, name: string): Promise<Buffer | null>;
+    importDmail(did: string): Promise<boolean>;
+    verifyDIDList(didList: string[]): Promise<string[]>;
+    verifyNotice(notice: NoticeMessage): Promise<NoticeMessage>;
+    createNotice(message: NoticeMessage, options?: CreateAssetOptions): Promise<string>;
+    updateNotice(id: string, message: NoticeMessage): Promise<boolean>;
+    addToNotices(did: string, tags: string[]): Promise<boolean>;
+    importNotice(did: string): Promise<boolean>;
+    searchNotices(): Promise<boolean>;
+    cleanupNotices(): Promise<boolean>;
+    refreshNotices(): Promise<boolean>;
+    exportEncryptedWallet(): Promise<WalletEncFile>;
+    private isBallot;
+    private addUnnamedPoll;
+    private getHDKeyFromCacheOrMnemonic;
+    private encryptWalletForStorage;
+    private decryptWalletFromStorage;
+    private decryptWallet;
+    private upgradeWallet;
+}

package/dist/types/node.d.ts

@@ -0,0 +1,6 @@
+export * from './index.js';
+export { default } from './index.js';
+export { default as WalletJson } from './db/json.js';
+export { default as WalletRedis } from './db/redis.js';
+export { default as WalletMongo } from './db/mongo.js';
+export { default as WalletSQLite } from './db/sqlite.js';

package/dist/types/search-client.d.ts

@@ -0,0 +1,9 @@
+import { WaitUntilReadyOptions, SearchClientOptions, SearchEngine } from './types.js';
+export default class SearchClient implements SearchEngine {
+    private API;
+    static create(options: SearchClientOptions): Promise<SearchClient>;
+    connect(options?: SearchClientOptions): Promise<void>;
+    waitUntilReady(options?: WaitUntilReadyOptions): Promise<void>;
+    isReady(): Promise<boolean>;
+    search(where: object): Promise<string[]>;
+}

package/dist/types/types.d.ts

@@ -0,0 +1,373 @@
+import { Cipher, EcdsaJwkPublic } from '@didcid/cipher/types';
+import { GatekeeperInterface, DidCidDocument, ResolveDIDOptions } from '@didcid/gatekeeper/types';
+export interface Seed {
+    /** Passphrase-encrypted mnemonic */
+    mnemonicEnc?: {
+        salt: string;
+        iv: string;
+        data: string;
+    };
+}
+export interface IDInfo {
+    did: string;
+    account: number;
+    index: number;
+    held?: string[];
+    owned?: string[];
+    dmail?: Record<string, any>;
+    notices?: Record<string, any>;
+    [key: string]: any;
+}
+export interface WalletEncFile {
+    version: number;
+    seed: Seed;
+    enc: string;
+}
+export interface WalletFile {
+    version?: number;
+    seed: Seed;
+    counter: number;
+    ids: Record<string, IDInfo>;
+    current?: string;
+    names?: Record<string, string>;
+    [key: string]: any;
+}
+export interface CheckWalletResult {
+    checked: number;
+    invalid: number;
+    deleted: number;
+}
+export interface FixWalletResult {
+    idsRemoved: number;
+    ownedRemoved: number;
+    heldRemoved: number;
+    namesRemoved: number;
+}
+export interface CreateAssetOptions {
+    registry?: string;
+    controller?: string;
+    validUntil?: string;
+    name?: string;
+}
+export interface FileAssetOptions extends CreateAssetOptions {
+    filename?: string;
+}
+export interface EncryptOptions extends CreateAssetOptions {
+    encryptForSender?: boolean;
+    includeHash?: boolean;
+}
+export interface Group {
+    name: string;
+    members: string[];
+}
+export interface Signature {
+    signer?: string;
+    signed: string;
+    hash: string;
+    value: string;
+}
+export interface VerifiableCredential {
+    "@context": string[];
+    type: string[];
+    issuer: string;
+    validFrom: string;
+    validUntil?: string;
+    credentialSubject?: {
+        id: string;
+    };
+    credential?: Record<string, unknown> | null;
+    signature?: Signature;
+}
+export interface IssueCredentialsOptions extends EncryptOptions {
+    schema?: string;
+    subject?: string;
+    validFrom?: string;
+    credential?: Record<string, unknown>;
+}
+export interface Challenge {
+    credentials?: {
+        schema: string;
+        issuers?: string[];
+    }[];
+    [key: string]: any;
+}
+export interface ChallengeResponse {
+    challenge: string;
+    credentials: {
+        vc: string;
+        vp: string;
+    }[];
+    requested: number;
+    fulfilled: number;
+    match: boolean;
+    vps?: unknown[];
+    responder?: string;
+}
+export interface CreateResponseOptions {
+    registry?: string;
+    validUntil?: string;
+    retries?: number;
+    delay?: number;
+}
+export interface PollResults {
+    tally: Array<{
+        vote: number;
+        option: string;
+        count: number;
+    }>;
+    ballots?: Array<{
+        ballot: string;
+        received: string;
+        voter: string;
+        vote: number;
+        option: string;
+    }>;
+    votes?: {
+        eligible: number;
+        received: number;
+        pending: number;
+    };
+    final?: boolean;
+}
+export interface Poll {
+    type: string;
+    version: number;
+    description: string;
+    roster: string;
+    options: string[];
+    deadline: string;
+    ballots?: Record<string, {
+        ballot: string;
+        received: string;
+    }>;
+    results?: PollResults;
+}
+export interface ViewPollResult {
+    description: string;
+    options: string[];
+    deadline: string;
+    isOwner: boolean;
+    isEligible: boolean;
+    voteExpired: boolean;
+    hasVoted: boolean;
+    results?: PollResults;
+}
+export interface BinaryAsset {
+    cid: string;
+    type: string;
+    bytes: number;
+    data?: Buffer;
+}
+export interface ImageAsset extends BinaryAsset {
+    width: number;
+    height: number;
+}
+export interface FileAsset extends BinaryAsset {
+    filename: string;
+}
+export interface GroupVault {
+    version?: number;
+    publicJwk: EcdsaJwkPublic;
+    salt: string;
+    config: string;
+    members: string;
+    keys: Record<string, string>;
+    items: string;
+    sha256: string;
+}
+export interface GroupVaultOptions extends CreateAssetOptions {
+    secretMembers?: boolean;
+    version?: number;
+}
+export interface GroupVaultLogin {
+    service: string;
+    username: string;
+    password: string;
+}
+export type StoredWallet = WalletFile | WalletEncFile | null;
+export interface WalletBase {
+    saveWallet(wallet: StoredWallet, overwrite?: boolean): Promise<boolean>;
+    loadWallet(): Promise<StoredWallet | null>;
+    updateWallet(mutator: (wallet: StoredWallet) => void | Promise<void>): Promise<void>;
+}
+export interface SearchEngine {
+    search(query: object): Promise<string[]>;
+}
+export interface KeymasterOptions {
+    passphrase: string;
+    gatekeeper: GatekeeperInterface;
+    wallet: WalletBase;
+    cipher: Cipher;
+    search?: SearchEngine;
+    defaultRegistry?: string;
+    maxNameLength?: number;
+}
+export interface EncryptedMessage {
+    sender: string;
+    created: string;
+    cipher_hash?: string | null;
+    cipher_sender?: string | null;
+    cipher_receiver?: string | null;
+}
+export interface PossiblySigned {
+    signature?: Signature;
+}
+export interface RestClientOptions {
+    url?: string;
+    console?: any;
+    waitUntilReady?: boolean;
+    intervalSeconds?: number;
+    chatty?: boolean;
+    becomeChattyAfter?: number;
+    maxRetries?: number;
+}
+export interface KeymasterClientOptions extends RestClientOptions {
+}
+export interface SearchClientOptions extends RestClientOptions {
+}
+export interface WaitUntilReadyOptions {
+    intervalSeconds?: number;
+    chatty?: boolean;
+    becomeChattyAfter?: number;
+    maxRetries?: number;
+}
+export interface DmailMessage {
+    to: string[];
+    cc: string[];
+    subject: string;
+    body: string;
+    reference?: string;
+}
+export interface DmailItem {
+    message: DmailMessage;
+    to: string[];
+    cc: string[];
+    sender: string;
+    date: string;
+    tags: string[];
+    attachments?: any;
+    docs?: any;
+}
+export interface NoticeMessage {
+    to: string[];
+    dids: string[];
+}
+export interface KeymasterInterface {
+    loadWallet(): Promise<WalletFile>;
+    saveWallet(wallet: StoredWallet, overwrite?: boolean): Promise<boolean>;
+    newWallet(mnemonic?: string, overwrite?: boolean): Promise<WalletFile>;
+    backupWallet(): Promise<boolean | string>;
+    recoverWallet(): Promise<WalletFile>;
+    checkWallet(): Promise<CheckWalletResult>;
+    fixWallet(): Promise<FixWalletResult>;
+    decryptMnemonic(): Promise<string>;
+    exportEncryptedWallet(): Promise<WalletEncFile>;
+    listIds(): Promise<string[]>;
+    getCurrentId(): Promise<string | undefined>;
+    setCurrentId(name: string): Promise<boolean>;
+    createId(name: string, options?: {
+        registry?: string;
+    }): Promise<string>;
+    removeId(id: string): Promise<boolean>;
+    renameId(id: string, newName: string): Promise<boolean>;
+    backupId(id?: string): Promise<boolean>;
+    recoverId(did: string): Promise<string>;
+    listNames(): Promise<Record<string, string>>;
+    addName(name: string, did: string): Promise<boolean>;
+    getName(name: string): Promise<string | null>;
+    removeName(name: string): Promise<boolean>;
+    resolveDID(did: string, options?: ResolveDIDOptions): Promise<DidCidDocument>;
+    createAsset(data: unknown, options?: CreateAssetOptions): Promise<string>;
+    listAssets(owner?: string): Promise<string[]>;
+    resolveAsset(did: string, options?: ResolveDIDOptions): Promise<unknown | null>;
+    updateAsset(did: string, data: Record<string, unknown>): Promise<boolean>;
+    encryptMessage(msg: string, receiver: string, options?: EncryptOptions): Promise<string>;
+    decryptMessage(did: string): Promise<string>;
+    encryptJSON(json: unknown, receiver: string, options?: EncryptOptions): Promise<string>;
+    decryptJSON(did: string): Promise<unknown>;
+    createGroup(name: string, options?: CreateAssetOptions): Promise<string>;
+    getGroup(group: string): Promise<Group | null>;
+    addGroupMember(group: string, member: string): Promise<boolean>;
+    removeGroupMember(group: string, member: string): Promise<boolean>;
+    testGroup(group: string, member?: string): Promise<boolean>;
+    listGroups(owner?: string): Promise<string[]>;
+    createSchema(schema?: unknown, options?: CreateAssetOptions): Promise<string>;
+    getSchema(did: string): Promise<unknown | null>;
+    setSchema(did: string, schema: unknown): Promise<boolean>;
+    testSchema(did: string): Promise<boolean>;
+    listSchemas(owner?: string): Promise<string[]>;
+    testAgent(did: string): Promise<boolean>;
+    bindCredential(schema: string, subject: string, options?: {
+        validFrom?: string;
+        validUntil?: string;
+        credential?: Record<string, unknown>;
+    }): Promise<VerifiableCredential>;
+    issueCredential(credential: Partial<VerifiableCredential>, options?: IssueCredentialsOptions): Promise<string>;
+    sendCredential(did: string, options?: CreateAssetOptions): Promise<string | null>;
+    updateCredential(did: string, credential: VerifiableCredential): Promise<boolean>;
+    revokeCredential(did: string): Promise<boolean>;
+    listIssued(issuer?: string): Promise<string[]>;
+    acceptCredential(did: string): Promise<boolean>;
+    getCredential(did: string): Promise<VerifiableCredential | null>;
+    removeCredential(did: string): Promise<boolean>;
+    listCredentials(id?: string): Promise<string[]>;
+    publishCredential(did: string, options?: {
+        reveal?: boolean;
+    }): Promise<VerifiableCredential | boolean>;
+    unpublishCredential(did: string): Promise<string | boolean>;
+    createChallenge(challenge?: Challenge, options?: {
+        registry?: string;
+        validUntil?: string;
+    }): Promise<string>;
+    createResponse(challengeDid: string, options?: CreateResponseOptions): Promise<string>;
+    verifyResponse(responseDid: string, options?: {
+        retries?: number;
+        delay?: number;
+    }): Promise<ChallengeResponse>;
+    pollTemplate(): Promise<Poll>;
+    createPoll(poll: Poll, options?: CreateAssetOptions): Promise<string>;
+    getPoll(pollId: string): Promise<Poll | null>;
+    viewPoll(pollId: string): Promise<ViewPollResult>;
+    votePoll(pollId: string, vote: number, options?: {
+        spoil?: boolean;
+        registry?: string;
+        validUntil?: string;
+    }): Promise<string>;
+    updatePoll(ballot: string): Promise<boolean>;
+    publishPoll(pollId: string, options?: {
+        reveal?: boolean;
+    }): Promise<boolean>;
+    unpublishPoll(pollId: string): Promise<boolean>;
+    createImage(data: Buffer, options?: CreateAssetOptions): Promise<string>;
+    updateImage(did: string, data: Buffer): Promise<boolean>;
+    getImage(id: string): Promise<ImageAsset | null>;
+    testImage(id: string): Promise<boolean>;
+    createDocument(data: Buffer, options?: FileAssetOptions): Promise<string>;
+    updateDocument(did: string, data: Buffer, options?: FileAssetOptions): Promise<boolean>;
+    getDocument(id: string): Promise<FileAsset | null>;
+    testDocument(id: string): Promise<boolean>;
+    createGroupVault(options?: CreateAssetOptions): Promise<string>;
+    getGroupVault(vaultId: string, options?: ResolveDIDOptions): Promise<GroupVault>;
+    testGroupVault(vaultId: string, options?: ResolveDIDOptions): Promise<boolean>;
+    addGroupVaultMember(vaultId: string, memberId: string): Promise<boolean>;
+    removeGroupVaultMember(vaultId: string, memberId: string): Promise<boolean>;
+    addGroupVaultItem(vaultId: string, name: string, buffer: Buffer): Promise<boolean>;
+    removeGroupVaultItem(vaultId: string, name: string): Promise<boolean>;
+    listGroupVaultItems(vaultId: string, options?: ResolveDIDOptions): Promise<Record<string, any>>;
+    getGroupVaultItem(vaultId: string, name: string, options?: ResolveDIDOptions): Promise<Buffer | null>;
+    createDmail(message: DmailMessage, options?: CreateAssetOptions): Promise<string>;
+    updateDmail(did: string, message: DmailMessage): Promise<boolean>;
+    fileDmail(did: string, tags: string[]): Promise<boolean>;
+    removeDmail(did: string): Promise<boolean>;
+    importDmail(did: string): Promise<boolean>;
+    getDmailMessage(did: string, options?: ResolveDIDOptions): Promise<DmailMessage | null>;
+    listDmail(): Promise<Record<string, DmailItem>>;
+    sendDmail(did: string): Promise<string | null>;
+    addDmailAttachment(did: string, name: string, buffer: Buffer): Promise<boolean>;
+    removeDmailAttachment(did: string, name: string): Promise<boolean>;
+    listDmailAttachments(did: string, options?: ResolveDIDOptions): Promise<Record<string, any>>;
+    getDmailAttachment(did: string, name: string): Promise<Buffer | null>;
+    createNotice(message: NoticeMessage, options: CreateAssetOptions): Promise<string>;
+    updateNotice(did: string, message: NoticeMessage): Promise<boolean>;
+    refreshNotices(): Promise<boolean>;
+}