// Copyright (c) Cratis. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

import { ObservableQuerySubscription } from './ObservableQuerySubscription';
import { QueryResult } from './QueryResult';
import { IQuery } from './IQuery';
import { IHaveParameters } from '../reflection/IHaveParameters';

/**
 * The delegate type representing the callback of result from the server.
 */
export type OnNextResult<TDataType> = (data: TDataType) => void;

/**
 * Defines the base of a query.
 * @template TDataType Type of model the query is for.
 * @template TArguments Optional type of arguments to use for the query.
 */
export interface IObservableQueryFor<TDataType, TArguments = object> extends IQuery, IHaveParameters {
    readonly route: string;
    readonly requiredRequestParameters: string[];
    readonly defaultValue: TDataType;

    /**
     * Subscribe to the query. This will create a subscription onto the server.
     * @param {OnNextResult} callback The callback that will receive result from the server.
     * @param [args] Optional arguments for the query - depends on whether or not the query needs arguments.
     * @returns {ObservableQuerySubscription<TDataType>}.
     */
    subscribe(callback: OnNextResult<QueryResult<TDataType>>, args?: TArguments): ObservableQuerySubscription<TDataType>;

    /**
     * Perform the query using HTTP to get a single result instead of subscribing via WebSocket.
     * @param [args] Optional arguments for the query - depends on whether or not the query needs arguments.
     * @returns {Promise<QueryResult<TDataType>>} for the model
     */
    perform(args?: TArguments): Promise<QueryResult<TDataType>>;
}