import {Document} from 'idai-components-2';
import {Query} from './query';

/**
 * The interface providing read access methods
 * for datastores supporting the idai-components-2 document model.
 * For full access see <code>Datastore</code>
 *
 * Implementations guarantee that any of the methods declared here
 * have no effect on any of the documents within the datastore.
 *
 * @author Sebastian Cuy
 * @author Daniel de Oliveira
 * @author Thomas Kleinke
 */
export abstract class ReadDatastore {

    /**
     * @param resourceId the desired document's resource id
     * @param options to control implementation specific behaviour
     * @returns {Promise<Document>} a document (rejects with msgWithParams in case of error)
     * @throws [DOCUMENT_NOT_FOUND] - in case document is missing
     * @throws [INVALID_DOCUMENT] - in case document is not valid
     */
    abstract get(resourceId: string, options?: Object): Promise<Document>;


    /**
     * @param resourceIds the resource ids of the documents to find
     * @returns {Promise<Array<Document>>} list of found documents
     */
    abstract getMultiple(resourceIds: string[]): Promise<Array<Document>>;


    /**
     * Perform a fulltext query

     * @param query the query object
     * @returns {Promise<Document[]>} an array of documents
     * @throws [GENERIC_ERROR (, cause: any)] - in case of error, optionally including a cause
     */
    abstract find(query: Query): Promise<FindResult>;


    abstract findIds(query: Query): FindIdsResult;
}


export interface FindIdsResult {

    ids: string[];
    totalCount: number;
    queryId?: string;
}


export interface FindResult extends FindIdsResult {

    documents: Array<Document>;
}


export module FindResult {

    export const DOCUMENTS = 'documents';
    export const TOTALCOUNT = 'totalCount';
}