import { UrlParametersInState } from './navigation-config.model';
import { TrackingConfig } from './tracking-config.model';

export interface AppConfiguration {
  pfeConfig: PfeConfig;
}

export interface PfeConfig {
  /**
   * The key name in the state, that is used for the
   * display of generic validation messages.
   */
  validationErrorStateKey?: string;

  /**
   * @deprecated true
   * @deprecationMessage This attribute never actually did anything and will be removed soon.
   */
  stateIDStateKey?: string;

  /**
   * Allows the user to directly navigate into some location within the flow
   * without a restored state.
   * Default is false, which means the user gets redirected to the first page, if no state
   * was restored.
   */
  allowDirectNavigationWithoutState?: boolean;

  /**
   * The label to be displayed on the next button.
   * Can be used to change the translation key with ngx-translate or any other dynamic translation tool/library.
   * Can not be used for dynamic translation keys with the native Angular translation or any other static translation tool/library.
   */
  nextButtonLabel?: string;

  /**
   * The label to be displayed on the back button.
   * Can be used to change the translation key with ngx-translate or any other dynamic translation tool/library.
   * Can not be used for dynamic translation keys with the native Angular translation or any other static translation tool/library.
   */
  backButtonLabel?: string;

  /**
   * Boolean to enable state restoration by sessionStorage
   */
  enableSessionStorageState?: boolean;

  /**
   * Boolean to enable stateStale
   */
  enableStateCleaning?: boolean;

  /**
   * Boolean to enable state clean on page Navigation
   * if set to true when page is revisited it will auto clean up data
   */
  autoCleanStaleState?: boolean;

  /**
   * Array of pages to exclude from staleState analysis.
   */
  excludeFromStaleState?: string[];

  trackingConfig?: TrackingConfig;

  /**
   * Array of specific url parameter key and expression to save value to state.
   */
  urlParametersInState?: UrlParametersInState[];

  /**
   * Automatically fallback to the history, if none of the entries in a backOptionList are valid.
   *
   * @default false
   */
  backOptionListFallBackToHistory?: boolean;
}