import { SymmetricKey } from "cloudproof_kms_js";
import { DbInterface } from "./backend";
import { IndexedEntry, Interrupt, Keyword, SearchResults } from "./types";
export interface InstantiatedFindex {
    /**
     * Add the given values to this Findex index for the corresponding
     * keywords.
     * @param {Uint8Array} key
     * @param {string} label
     * @param {Array<{indexedValue: Uint8Array, keywords: Array<Uint8Array>}>} associations
     * @returns {Promise<Array<Uint8Array>>}
     */
    add: (key: Uint8Array, label: string, associations: Array<{
        indexedValue: Uint8Array;
        keywords: Uint8Array[];
    }>) => Promise<Uint8Array[]>;
    /**
     * Remove the given values from this Findex index for the corresponding
     * keywords.
     * @param {Uint8Array} key
     * @param {Uint8Array} label
     * @param {Array<{indexedValue: Uint8Array, keywords: Array<Uint8Array>}>} associations
     * @returns {Promise<Array<Uint8Array>>}
     */
    delete: (key: Uint8Array, label: string, associations: Array<{
        indexedValue: Uint8Array;
        keywords: Uint8Array[];
    }>) => Promise<Uint8Array[]>;
    /**
     * Searches this Findex instance for the given keywords.
     *
     * The interrupt is called at each search graph level with the level's
     * results and allows interrupting the search.
     * @param {Uint8Array} key
     * @param {Uint8Array} label
     * @param {Array<Uint8Array>} keywords
     * @param {Function} interrupt
     * @returns {Promise<Array<{ keyword: Uint8Array, results: Array<Uint8Array> }>>}
     */
    search: (key: Uint8Array, label: string, keywords: Uint8Array[], interrupt?: Interrupt) => Promise<Array<{
        keyword: Uint8Array;
        results: Uint8Array[];
    }>>;
}
/**
 * Findex definition
 * @returns {Promise<Findex>} results found at every node while the search walks the search graph
 */
export declare class Findex {
    key: Uint8Array;
    label: string;
    _instantiatedFindex: InstantiatedFindex | null;
    constructor(key: SymmetricKey | Uint8Array, label: string);
    /**
     * Instantiates a custom interface.
     * @param entryInterface Entry Table DB interface
     * @param chainInterface  Chain Table DB interface
     */
    instantiateCustomInterface(entryInterface: DbInterface, chainInterface?: DbInterface): Promise<void>;
    /**
     * Instantiates a Findex REST interface using the given token and URL.
     * @param token findex server authorization token
     * @param entryUrl entry table url
     * @param chainUrl chain table url
     */
    instantiateRestInterface(token: string, entryUrl: string, chainUrl?: string): Promise<void>;
    /**
     * Add the given associations to the index.
     * @param {IndexedEntry[]} associations new entries to upsert in indexes
     * @param options Additional optional options
     * @param options.verbose the optional verbose bool parameter
     * @returns {Keyword[]} the list of the newly inserted keywords in the index
     * @throws when the DB interface is not instantiated
     */
    add(associations: IndexedEntry[], options?: {
        verbose?: false;
    }): Promise<Keyword[]>;
    /**
     * Delete the given associations from the index.
     * @param {IndexedEntry[]} associations new entries to upsert in indexes
     * @param options Additional optional options
     * @param options.verbose the optional verbose bool parameter
     * @returns {Keyword[]} the list of the newly inserted keywords in the index
     * @throws when the DB interface is not instantiated
     */
    delete(associations: IndexedEntry[], options?: {
        verbose?: false;
    }): Promise<Keyword[]>;
    /**
     * Search for the given keywords in the index and return the corresponding
     * data.
     * @param keywords keywords to search inside the indexes
     * @param options Additional optional options to the search
     * @param options.userInterrupt the optional callback of found values as the search graph is walked. Returning `true` stops the walk
     * @param options.verbose the optional verbose bool parameter
     * @returns the search results
     * @throws when the DB interface is not instantiated
     */
    search(keywords: Set<string | Uint8Array> | Array<string | Uint8Array>, options?: {
        userInterrupt?: Interrupt;
        verbose?: false;
    }): Promise<SearchResults>;
}
//# sourceMappingURL=findex.d.ts.map