import { StarkBackendAuthenticationTypes } from "./backend-authentication-types";

/**
 * Description of a back-end that the application interacts with.
 */
export interface StarkBackend {
	/**
	 * The name of the back-end. Referred to in the Http repositories implementation.
	 */
	name: string;

	/**
	 * URL of the back-end.
	 */
	url: string;

	/**
	 * Authentication type for that back-end.
	 */
	authenticationType: StarkBackendAuthenticationTypes;

	/**
	 * Set this to `true` if fake pre-authentication should be enabled.
	 *
	 * When enabled **and** running development mode, Stark will add the authentication headers,
	 * that are provided by the client application, to each request.
	 * The Dev-Authentication headers provide the information expected
	 * by the back-end for authentication.
	 *
	 * In real environments, infrastructure takes care of this.
	 *
	 * **This should never be enabled for user acceptance or production environments!**
	 */
	devAuthenticationEnabled: boolean;

	/**
	 * Prefix for roles. Added to each role when sent to the back-end.
	 * **Must** add the prefix that the back-end expects
	 * This is necessary to mimic the behavior of the WAF
	 */
	devAuthenticationRolePrefix: string;

	/**
	 * Path of the login resource.
	 */
	loginResource?: string;

	/**
	 * Value holder for retrieve tokens (e.g., JWT).
	 */
	token?: string;
}