import { Scenario } from './Scenario';
import { ActionType, ActionTypeType } from './ActionType';
import { ActionCallback } from './ActionCallback';

export interface ActionDefinition {
    readonly description?: string;
    readonly type: ActionTypeType;
    readonly invokeEvenOnFail?: boolean;
    readonly allowFailure?: boolean;
}

export function isValidActionDefinition(
    toBeValidated: unknown,
): toBeValidated is ActionDefinition {
    if (typeof toBeValidated !== 'object' || toBeValidated === null) {
        return false;
    }
    const actionDef = toBeValidated as ActionDefinition;
    return (
        ['string', 'undefined'].includes(typeof actionDef.description) &&
        actionDef.type in ActionType &&
        ['boolean', 'undefined'].includes(typeof actionDef.invokeEvenOnFail) &&
        ['boolean', 'undefined'].includes(typeof actionDef.allowFailure)
    );
}

export interface Action {
    readonly name: string;
    readonly description: string;
    readonly type: ActionType;
    invoke(scenario: Scenario): ActionCallback;
    readonly invokeEvenOnFail: boolean;
    readonly allowFailure: boolean;
}