feat: add tvdb indexer

cypress/e2e/providers/tvdb.cy.ts

@@ -0,0 +1,149 @@
+describe('TVDB Integration', () => {
+  // Constants for routes and selectors
+  const ROUTES = {
+    home: '/',
+    metadataSettings: '/settings/metadata',
+    tomorrowIsOursTvShow: '/tv/72879',
+    monsterTvShow: '/tv/225634',
+    dragonnBallZKaiAnime: '/tv/61709',
+  };
+
+  const SELECTORS = {
+    sidebarToggle: '[data-testid=sidebar-toggle]',
+    sidebarSettingsMobile: '[data-testid=sidebar-menu-settings-mobile]',
+    settingsNavDesktop: 'nav[data-testid="settings-nav-desktop"]',
+    metadataTestButton: 'button[type="button"]:contains("Test")',
+    metadataSaveButton: '[data-testid="metadata-save-button"]',
+    tmdbStatus: '[data-testid="tmdb-status"]',
+    tvdbStatus: '[data-testid="tvdb-status"]',
+    tvIndexerSelector: '[data-testid="tv-indexer-selector"]',
+    animeIndexerSelector: '[data-testid="anime-indexer-selector"]',
+    seasonSelector: '[data-testid="season-selector"]',
+    season1: 'Season 1',
+    season2: 'Season 2',
+    season3: 'Season 3',
+    episodeList: '[data-testid="episode-list"]',
+    episode9: '9 - Hang Men',
+  };
+
+  // Reusable commands
+  const navigateToMetadataSettings = () => {
+    cy.visit(ROUTES.home);
+    cy.get(SELECTORS.sidebarToggle).click();
+    cy.get(SELECTORS.sidebarSettingsMobile).click();
+    cy.get(
+      `${SELECTORS.settingsNavDesktop} a[href="${ROUTES.metadataSettings}"]`
+    ).click();
+  };
+
+  const testAndVerifyMetadataConnection = () => {
+    cy.intercept('POST', '/api/v1/settings/metadatas/test').as(
+      'testConnection'
+    );
+    cy.get(SELECTORS.metadataTestButton).click();
+    return cy.wait('@testConnection');
+  };
+
+  const saveMetadataSettings = (customBody = null) => {
+    // Si un corps personnalisé est fourni, utilisez-le pour modifier la requête
+    if (customBody) {
+      cy.intercept('PUT', '/api/v1/settings/metadatas', (req) => {
+        req.body = customBody;
+      }).as('saveMetadata');
+    } else {
+      // Sinon, juste intercepter sans modifier
+      cy.intercept('PUT', '/api/v1/settings/metadatas').as('saveMetadata');
+    }
+
+    cy.get(SELECTORS.metadataSaveButton).click();
+    return cy.wait('@saveMetadata');
+  };
+
+  beforeEach(() => {
+    // Perform login
+    cy.login(Cypress.env('ADMIN_EMAIL'), Cypress.env('ADMIN_PASSWORD'));
+
+    // Navigate to Metadata settings
+    navigateToMetadataSettings();
+
+    // Verify we're on the correct settings page
+    cy.contains('h3', 'Metadata').should('be.visible');
+
+    // Configure TVDB as TV provider and test connection
+    // Supposons que vous avez ajouté data-testid au div parent du Select
+    cy.get('[data-testid="tv-indexer-selector"]').click();
+
+    // get id react-select-4-option-1
+    cy.get('[id^="react-select-4-option-"]').contains('TheTVDB').click();
+
+    // Test the connection
+    testAndVerifyMetadataConnection().then(({ response }) => {
+      expect(response.statusCode).to.equal(200);
+      // Check TVDB connection status
+      cy.get(SELECTORS.tvdbStatus).should('contain', 'Operational');
+    });
+
+    // Save settings
+    saveMetadataSettings({
+      anime: 'tvdb',
+      tv: 'tvdb',
+    }).then(({ response }) => {
+      expect(response.statusCode).to.equal(200);
+      expect(response.body.tv).to.equal('tvdb');
+    });
+  });
+
+  it('should display "Tomorrow is Ours" show information with multiple seasons from TVDB', () => {
+    // Navigate to the TV show
+    cy.visit(ROUTES.tomorrowIsOursTvShow);
+
+    // Verify that multiple seasons are displayed (TMDB has only 1 season, TVDB has multiple)
+    //cy.get(SELECTORS.seasonSelector).should('exist');
+    cy.intercept('/api/v1/tv/225634/season/1').as('season1');
+    // Select Season 2 and verify it loads
+    cy.contains(SELECTORS.season2)
+      .should('be.visible')
+      .scrollIntoView()
+      .click();
+
+    // Verify that episodes are displayed for Season 2
+    cy.contains('260 - Episode 506').should('be.visible');
+  });
+
+  it('Should display "Monster" show information correctly when not existing on TVDB', () => {
+    // Navigate to the TV show
+    cy.visit(ROUTES.monsterTvShow);
+
+    // Intercept season 1 request
+    cy.intercept('/api/v1/tv/225634/season/1').as('season1');
+
+    // Select Season 1
+    cy.contains(SELECTORS.season1)
+      .should('be.visible')
+      .scrollIntoView()
+      .click();
+
+    // Wait for the season data to load
+    cy.wait('@season1');
+
+    // Verify specific episode exists
+    cy.contains(SELECTORS.episode9).should('be.visible');
+  });
+
+  it('should display "Dragon Ball Z Kai" show information with multiple only 2 seasons from TVDB', () => {
+    // Navigate to the TV show
+    cy.visit(ROUTES.dragonnBallZKaiAnime);
+
+    // Intercept season 1 request
+    cy.intercept('/api/v1/tv/61709/season/1').as('season1');
+
+    // Select Season 2 and verify it visible
+    cy.contains(SELECTORS.season2)
+      .should('be.visible')
+      .scrollIntoView()
+      .click();
+
+    // select season 3 and verify it not visible
+    cy.contains(SELECTORS.season3).should('not.exist');
+  });
+});

jellyseerr-api.yml

@@ -519,6 +519,20 @@ components:
         serverID:
           type: string
           readOnly: true
+    MetadataSettings:
+      type: object
+      properties:
+        settings:
+          type: object
+          properties:
+            tv:
+              type: string
+              enum: [tvdb, tmdb]
+              example: 'tvdb'
+            anime:
+              type: string
+              enum: [tvdb, tmdb]
+              example: 'tvdb'
     TautulliSettings:
       type: object
       properties:
@@ -2568,6 +2582,67 @@ paths:
                       type: string
                     thumb:
                       type: string
+  /settings/metadatas:
+    get:
+      summary: Get Metadata settings
+      description: Retrieves current Metadata settings.
+      tags:
+        - settings
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MetadataSettings'
+    put:
+      summary: Update Metadata settings
+      description: Updates Metadata settings with the provided values.
+      tags:
+        - settings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MetadataSettings'
+      responses:
+        '200':
+          description: 'Values were successfully updated'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MetadataSettings'
+  /settings/metadatas/test:
+    post:
+      summary: Test Provider configuration
+      description: Tests if the TVDB configuration is valid. Returns a list of available languages on success.
+      tags:
+        - settings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                tmdb:
+                  type: boolean
+                  example: true
+                tvdb:
+                  type: boolean
+                  example: true
+      responses:
+        '200':
+          description: Succesfully connected to TVDB
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: 'Successfully connected to TVDB'
   /settings/tautulli:
     get:
       summary: Get Tautulli settings
@@ -6472,7 +6547,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/TvDetails'
-  /tv/{tvId}/season/{seasonId}:
+  /tv/{tvId}/season/{seasonNumber}:
     get:
       summary: Get season details and episode list
       description: Returns season details with a list of episodes in a JSON object.
@@ -6486,11 +6561,11 @@ paths:
             type: number
             example: 76479
         - in: path
-          name: seasonId
+          name: seasonNumber
           required: true
           schema:
             type: number
-            example: 1
+            example: 123456
         - in: query
           name: language
           schema:

server/api/externalapi.ts

@@ -10,7 +10,7 @@ const DEFAULT_TTL = 300;
 // 10 seconds default rolling buffer (in ms)
 const DEFAULT_ROLLING_BUFFER = 10000;
 
-interface ExternalAPIOptions {
+export interface ExternalAPIOptions {
   nodeCache?: NodeCache;
   headers?: Record<string, unknown>;
   rateLimit?: {

server/api/metadata.ts

@@ -0,0 +1,36 @@
+import type { TvShowProvider } from '@server/api/provider';
+import TheMovieDb from '@server/api/themoviedb';
+import Tvdb from '@server/api/tvdb';
+import { getSettings, IndexerType } from '@server/lib/settings';
+import logger from '@server/logger';
+
+export const getMetadataProvider = async (
+  mediaType: 'movie' | 'tv' | 'anime'
+): Promise<TvShowProvider> => {
+  try {
+    const settings = await getSettings();
+
+    if (mediaType == 'movie') {
+      return new TheMovieDb();
+    }
+
+    if (mediaType == 'tv' && settings.metadataSettings.tv == IndexerType.TVDB) {
+      return await Tvdb.getInstance();
+    }
+
+    if (
+      mediaType == 'anime' &&
+      settings.metadataSettings.anime == IndexerType.TVDB
+    ) {
+      return await Tvdb.getInstance();
+    }
+
+    return new TheMovieDb();
+  } catch (e) {
+    logger.error('Failed to get metadata provider', {
+      label: 'Metadata',
+      message: e.message,
+    });
+    return new TheMovieDb();
+  }
+};

server/api/provider.ts

@@ -0,0 +1,30 @@
+import type {
+  TmdbSeasonWithEpisodes,
+  TmdbTvDetails,
+} from '@server/api/themoviedb/interfaces';
+
+export interface TvShowProvider {
+  getTvShow({
+    tvId,
+    language,
+  }: {
+    tvId: number;
+    language?: string;
+  }): Promise<TmdbTvDetails>;
+  getTvSeason({
+    tvId,
+    seasonNumber,
+    language,
+  }: {
+    tvId: number;
+    seasonNumber: number;
+    language?: string;
+  }): Promise<TmdbSeasonWithEpisodes>;
+  getShowByTvdbId({
+    tvdbId,
+    language,
+  }: {
+    tvdbId: number;
+    language?: string;
+  }): Promise<TmdbTvDetails>;
+}

server/api/themoviedb/index.ts

@@ -1,4 +1,5 @@
 import ExternalAPI from '@server/api/externalapi';
+import type { TvShowProvider } from '@server/api/provider';
 import cacheManager from '@server/lib/cache';
 import { getSettings } from '@server/lib/settings';
 import { sortBy } from 'lodash';
@@ -120,7 +121,7 @@ interface DiscoverTvOptions {
   certificationCountry?: string;
 }
 
-class TheMovieDb extends ExternalAPI {
+class TheMovieDb extends ExternalAPI implements TvShowProvider {
   private locale: string;
   private discoverRegion?: string;
   private originalLanguage?: string;
@@ -341,6 +342,13 @@ class TheMovieDb extends ExternalAPI {
         }
       );
 
+      data.episodes = data.episodes.map((episode) => {
+        if (episode.still_path) {
+          episode.still_path = `https://image.tmdb.org/t/p/original/${episode.still_path}`;
+        }
+        return episode;
+      });
+
       return data;
     } catch (e) {
       throw new Error(`[TMDB] Failed to fetch TV show details: ${e.message}`);

server/api/themoviedb/interfaces.ts

@@ -220,7 +220,7 @@ export interface TmdbTvEpisodeResult {
   show_id: number;
   still_path: string;
   vote_average: number;
-  vote_cuont: number;
+  vote_count: number;
 }
 
 export interface TmdbTvSeasonResult {