juice-shop/juice-shop

export interface FilterSetting {
  // categories to display. if empty, all categories are displayed
  categories: string[]

  // difficulties to display. if empty, all difficulties are displayed
  difficulties: Array<1 | 2 | 3 | 4 | 5 | 6>

  // tags to display. if empty, all tags are displayed
  tags: string[]

  // status to display. if null, all status are displayed
  status: SolvedStatus | null

  // search query to search challenge names & descriptions for. if null, all challenges are displayed
  searchQuery: string | null

  // whether to show disabled challenges
  showDisabledChallenges: boolean

  // if true only challenges belonging to a tutorial are displayed until the user has solved all tutorial challenges
  restrictToTutorialChallengesFirst: boolean
}

export type SolvedStatus = 'solved' | 'unsolved' | 'partially-solved'

export const DEFAULT_FILTER_SETTING: Readonly<FilterSetting> = Object.freeze({
  categories: [],
  difficulties: [],
  tags: [],
  status: null,
  searchQuery: null,
  showDisabledChallenges: true,
  restrictToTutorialChallengesFirst: false
})