/// <reference types="@rbxts/compiler-types" />
import { Signal } from '@rbxts/beacon';
import { Prompt_Choice } from './types/Prompt_Choice';
import { Prompt_Compact } from './types/Prompt_Compact';
import { UIResolver } from './UIResolver';
import { Timer, TimerType } from './Timer';
/**
 * @category Prompt
 * The PromptTypes that can be used when creating a new Prompt object.
 */
export declare enum PromptType {
    /** The custom mode can include any prompt UI but must have it's elements linked to the Prompt Instance. */
    Custom = "Custom",
    /** The Compact mode includes a close button at the top right with a confirm button in the bottom middle. */
    Compact = "Compact",
    /** The Choice mode includes a title with a message box and a accept or decline button next to each other at the bottom. */
    Choice = "Choice"
}
/**
 * The PromptPayload that is sent during accepted fullfillment of the prompt.
 * @category Prompt
 * @example
 * ```
 * prompt.OnFulfill.Connect((accepted: boolean,payload?: PromptPayload) => {
 *     if (accepted && payload) {
 *         print(payload.promptContent);
 *     }
 * });
 * ```
 *
 * Assuming we had a Prompt with a ScrollingFrame as the Content
 * and it contains 1 TextLabel named 'Money' and 1 TextBox named 'Nickname'
 *
 * Your output would look like this
 * ```
 * {
 *     ["Money"] = "350",
 *     ["Nickname"] = "Jen"
 * }
 * ```
 */
export type PromptPayload<TimerT extends TimerType | null = null> = {
    /** The Prompt that this payload belongs too. */
    prompt: Prompt<TimerT>;
    /** A map of the extracted content of this prompt. { [InstanceName]: Content } */
    promptContent: Map<string, string>;
};
/**
 * This is an enum of the TimeoutBehavior which contains behaviour for when the Prompt times out.
 * @enum {number}
 */
declare enum TimeoutBehavior {
    /** The Prompt will be cancelled when timed out. This will call the {@link Prompt.OnCancel} event. */
    CancelOnTimeout = 0,
    /** The Prompt will be rejected when timed out. This will call the {@link Prompt.OnFulfill} event with accepted as declined(false). */
    RejectOnTimeout = 1
}
/**
 * PromptOptions allow you to configure the prompts behavior.
 * @category Prompt
 * @interface
 */
export interface PromptOptions {
    /**
     * When the Prompt is timed out it will then also be destroyed.
     * @defaultValue true
     */
    destroyOnTimeout: boolean;
    /**
     * Controls the behavior when the Prompt is timed out.
     * @defaultValue {@link TimeoutBehavior.RejectOnTimeout}
     * @see {@link TimeoutBehavior}
     */
    timeoutBehavior: TimeoutBehavior;
}
declare const promptChoice: Prompt_Choice;
declare const promptCompact: Prompt_Compact;
/**
 * The main class used to create & use Prompts.
 * @category Prompt
 * @example
 * const prompt: Prompt = new Prompt(PromptType.Choice,"ExamplePrompt","Example message") || new Prompt(PromptType.Compact,"ExamplePrompt","Example message") || new Prompt(PromptType.Custom,"ExamplePrompt","Example message");
 * prompt.OnFulfill.Connect((accepted: boolean,payload: PromptPayload) => {
 *     if (accepted && payload) {
 *         if (payload.PromptContent.has("SomeInstanceName")) // Do something with data
 *     }
 *     prompt.Destroy();
 * });
 *
 * prompt.OnCancel.Connect((reason?: string) => {
 *     warn("Prompt was cancelled for reason: " + reason);
 *     // Other logic upon cancel
 *     prompt.Destroy();
 * });
 *
 *
 * // Tips:
 *
 * // - You don't have to destroy the prompt, after it's first prompt it can be reused.
 *
 * // - A prompt message that is passed into the contructor is used to display a text label automatically for you with text inside of it
 * //   TODO: It will later be accessible through a function that will allow you to change some properties.
 *
 */
declare class Prompt<T extends TimerType | null = null> {
    static ClassName: string;
    private static _promptsScreenUI?;
    /** The title of the Prompt. */
    Title: string;
    /**
     * The message of the Prompt. This is optional and when toggled a TextLabel
     * will be added to content for you with your specified message.
     */
    Message?: string;
    /**
     * The timeout of this Prompt, when a prompt times out it will fullfill as declined.
     * @defaultValue 0 when no timeout will be present, and the prompt will function indefinitely until {@link Prompt.Destroy}.
     */
    TimeOut: number;
    /** The configurable options of this Prompt. See {@link PromptOptions}*/
    Options: PromptOptions;
    /**
     * A property that is meant to store a validate function
     * that will be fired before Prompt.OnFulfill is called; and will
     * only be called if this function returns true.
     * @param payload - The PromptPayload data of the Prompt.
     * @returns boolean - True if the prompt payload is valid, false otherwise.
     */
    Validator?: (payload: PromptPayload<T>) => boolean;
    /**
     * @event
     * This event is fired when an input or timeout is received.
     */
    OnFulfill: Signal<[accepted: boolean, payload?: PromptPayload<T>]>;
    /**
     * @event
     * This event is fired when a prompt is cancelled for external reasons.
     */
    OnCancel: Signal<[reason?: string]>;
    /**
     * @private
     * The type of this Prompt.
     */
    private _type;
    /**
     * @private
     * The {@link Timer} of this Prompt used for time management.
     */
    private _timer?;
    /**
     * @private
     * @readonly
     * Whether the Prompt is already triggered or not.
     */
    private _triggered;
    /**
     * @private
     * @readonly
     * Whether the Prompt was cancelled or not.
     */
    private _cancelled;
    /**
     * @private
     * @readonly
     * Whether the Prompt has been destroyed or not.
     */
    private _destroyed;
    /**
     * @private
     * @readonly
     * This Prompts {@link UIResolver}.
     */
    private _UI;
    private _UIConnections;
    /**
     *
     * @param promptType - {@link PromptType.Custom}
     * @param title - The title of this Prompt.
     * @param message - The message of this Prompt or undefined for no message.
     * @param UI - The UIResolver that is provided to link custom instances to the intended structure.
     */
    constructor(promptType: PromptType.Custom, title: string, message: string | undefined, UI: UIResolver);
    constructor(promptType: PromptType.Compact, title: string, message: string | undefined);
    constructor(promptType: PromptType.Choice, title: string, message: string | undefined);
    /**
     * Triggers the prompt showing the prompt on top of the players screen.
     * If a time out is specified, a timer will start if no input is given
     * and the prompt will auto-fullfill with a declined status.
     */
    Trigger(): void;
    /** This method exposes _timer allowing you to set custom timer objects for your custom prompts. */
    SetTimer(timer: Timer<T extends TimerType ? T : never>): void;
    /**
     * @public
     * @param reason - The reason for cancelling the prompt.
     */
    Cancel(reason?: string): void;
    /**
     * @public
     * This method releases used resources and Destroys this Prompt.
     */
    Destroy(): void;
    /**
     * @private
     * Cleans the UI Connections that belong to this Prompt.
     */
    private cleanConnections;
    /**
     * @private
     * This starts and handles the prompts internal timing and functionality when {@link Prompt.TimeOut} is assigned.
     */
    private startPromptTimer;
    private __warn;
    private __error;
}
export { Prompt, UIResolver, Prompt_Choice, Prompt_Compact, promptChoice, promptCompact, TimeoutBehavior };