Refactor search query options

[github/Chocobozzz/PeerTube.git] / shared / models / search / videos-common-query.model.ts

import { VideoFilter } from '../videos'
import { BooleanBothQuery } from './boolean-both-query.model'

// These query parameters can be used with any endpoint that list videos
export interface VideosCommonQuery {
  start?: number
  count?: number
  sort?: string

  nsfw?: BooleanBothQuery

  isLive?: boolean

  categoryOneOf?: number[]

  licenceOneOf?: number[]

  languageOneOf?: string[]

  tagsOneOf?: string[]
  tagsAllOf?: string[]

  filter?: VideoFilter

  skipCount?: boolean
}

export interface VideosCommonQueryAfterSanitize extends VideosCommonQuery {
  start: number
  count: number
  sort: string
}

export interface VideosWithSearchCommonQuery extends VideosCommonQuery {
  search?: string
}