episodes.graphqls

enum EpisodeType {
    episode
    standalone
}

union EpisodeContextUnion = Season | ContextCollection

enum ShareRestriction {
    registered
    members
    public
}

type Episode implements CollectionItem & PlaylistItem & MediaItem {
    id: ID!
    uuid: String!
    status: Status!
    type: EpisodeType!
    legacyID: ID
    legacyProgramID: ID
    locked: Boolean! @goField(forceResolver: true)
    publishDate: Date!
    productionDate: Date!
    productionDateInTitle: Boolean!
    availableFrom: Date! @goField(forceResolver: true)
    availableTo: Date!
    ageRating: String!
    originalTitle: String! @goField(forceResolver: true)
    title: String! @goField(forceResolver: true)
    description: String!
    extraDescription: String!
    image(style: ImageStyle): String @goField(forceResolver: true)
    imageUrl: String @deprecated(reason: "Replaced by the image field")

    streams: [Stream!]! @goField(forceResolver: true)
    files(audioLanguages: [String!]): [File!]! @goField(forceResolver: true)
    chapters: [Chapter!]! @goField(forceResolver: true)
    skipToChapter: Chapter @goField(forceResolver: true)
    assetVersion: String!

    season: Season @goField(forceResolver: true)
    duration: Int!
    progress: Int @goField(forceResolver: true)
    watched: Boolean! @goField(forceResolver: true)
    audioLanguages: [Language!]!
    subtitleLanguages: [Language!]!
    context: EpisodeContextUnion @goField(forceResolver: true)
    relatedItems(first: Int, offset: Int): SectionItemPagination @goField(forceResolver: true)
    images: [Image!]!
    number: Int
    lessons(first: Int, offset: Int): LessonPagination! @goField(forceResolver: true)
    shareRestriction: ShareRestriction! @goField(forceResolver: true)
    inMyList: Boolean! @goField(forceResolver: true)

    """
    Should probably be used asynchronously, and retrieved separately from the episode, as it can be slow in some cases (a few db requests can occur)
    """
    next(limit: Int): [Episode!]! @goField(forceResolver: true)
    cursor: String! @goField(forceResolver: true)
}

type EpisodePagination implements Pagination {
    total: Int!
    first: Int!
    offset: Int!
    items: [Episode!]!
}

type Chapter implements CollectionItem {
    id: ID!
    start: Int!
    title: String!
    image: String
    description: String
    duration: Int!
    episode: Episode @goField(forceResolver: true)
    contentType: ContentType!
}

type File {
    id: ID!
    url: String!
    videoLanguage: Language
    audioLanguage: Language!
    subtitleLanguage: Language
    size: Int!
    fileName: String!
    mimeType: String!
    resolution: String
}

enum StreamType {
    hls_ts
    hls_cmaf
    dash
}

type Stream {
    id: ID!
    url: String!
    expiresAt: Date!
    videoLanguage: Language
    audioLanguages: [Language!]!
    subtitleLanguages: [Language!]!
    type: StreamType!
    downloadable: Boolean!
}