feat: add tvdb indexer

cypress/e2e/indexers/tvdb.cy.ts

@@ -0,0 +1,92 @@
+describe('TVDB Integration', () => {
+  // Constants for routes and selectors
+  const ROUTES = {
+    home: '/',
+    tvdbSettings: '/settings/tvdb',
+    tomorrowIsOursTvShow: '/tv/72879',
+    monsterTvShow: '/tv/225634',
+  };
+
+  const SELECTORS = {
+    sidebarToggle: '[data-testid=sidebar-toggle]',
+    sidebarSettingsMobile: '[data-testid=sidebar-menu-settings-mobile]',
+    settingsNavDesktop: 'nav[data-testid="settings-nav-desktop"]',
+    tvdbEnable: 'input[data-testid="tvdb-enable"]',
+    tvdbSaveButton: '[data-testid=tvbd-save-button]',
+    heading: '.heading',
+    season1: 'Season 1',
+    season2: 'Season 2',
+  };
+
+  // Reusable commands
+  const toggleTVDBSetting = () => {
+    cy.intercept('/api/v1/settings/tvdb').as('tvdbRequest');
+    cy.get(SELECTORS.tvdbSaveButton).click();
+    return cy.wait('@tvdbRequest');
+  };
+
+  const verifyTVDBResponse = (response, expectedUseValue) => {
+    expect(response.statusCode).to.equal(200);
+    expect(response.body.tvdb).to.equal(expectedUseValue);
+  };
+
+  beforeEach(() => {
+    // Perform login
+    cy.login(Cypress.env('ADMIN_EMAIL'), Cypress.env('ADMIN_PASSWORD'));
+
+    // Navigate to TVDB settings
+    cy.visit(ROUTES.home);
+    cy.get(SELECTORS.sidebarToggle).click();
+    cy.get(SELECTORS.sidebarSettingsMobile).click();
+    cy.get(
+      `${SELECTORS.settingsNavDesktop} a[href="${ROUTES.tvdbSettings}"]`
+    ).click();
+
+    // Verify heading
+    cy.get(SELECTORS.heading).should('contain', 'Tvdb');
+
+    // Configure TVDB settings
+    cy.get(SELECTORS.tvdbEnable).then(($checkbox) => {
+      const isChecked = $checkbox.is(':checked');
+
+      if (!isChecked) {
+        // If disabled, enable TVDB
+        cy.wrap($checkbox).click();
+        toggleTVDBSetting().then(({ response }) => {
+          verifyTVDBResponse(response, true);
+        });
+      } else {
+        // If enabled, disable then re-enable TVDB
+        cy.wrap($checkbox).click();
+        toggleTVDBSetting().then(({ response }) => {
+          verifyTVDBResponse(response, false);
+        });
+
+        cy.wrap($checkbox).click();
+        toggleTVDBSetting().then(({ response }) => {
+          verifyTVDBResponse(response, true);
+        });
+      }
+    });
+  });
+
+  it('should display "Tomorrow is Ours" show information correctly (1 season on TMDB >1 seasons on TVDB)', () => {
+    cy.visit(ROUTES.tomorrowIsOursTvShow);
+    cy.contains(SELECTORS.season2)
+      .should('be.visible')
+      .scrollIntoView()
+      .click();
+  });
+
+  it('Should display "Monster" show information correctly (Not existing on TVDB)', () => {
+    cy.visit(ROUTES.monsterTvShow);
+    cy.intercept('/api/v1/tv/225634/season/1').as('season1');
+    cy.contains(SELECTORS.season1)
+      .should('be.visible')
+      .scrollIntoView()
+      .click();
+    cy.wait('@season1');
+
+    cy.contains('9 - Hang Men').should('be.visible');
+  });
+});

overseerr-api.yml

@@ -405,6 +405,32 @@ 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'
+        providers:
+          type: object
+          properties:
+            tvdb:
+              type: object
+              properties:
+                apiKey:
+                  type: string
+                  example: '123456789'
+                pin:
+                  type: string
+                  example: '1234'
     TautulliSettings:
       type: object
       properties:
@@ -2378,6 +2404,54 @@ 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
+      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
@@ -5953,7 +6027,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.
@@ -5967,11 +6041,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

@@ -1,5 +1,3 @@
-import { MediaServerType } from '@server/constants/server';
-import { getSettings } from '@server/lib/settings';
 import type { RateLimitOptions } from '@server/utils/rateLimit';
 import rateLimit from '@server/utils/rateLimit';
 import type NodeCache from 'node-cache';
@@ -10,7 +8,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?: RateLimitOptions;
@@ -36,8 +34,6 @@ class ExternalAPI {
 
     const url = new URL(baseUrl);
 
-    const settings = getSettings();
-
     this.defaultHeaders = {
       'Content-Type': 'application/json',
       Accept: 'application/json',
@@ -46,9 +42,7 @@ class ExternalAPI {
           `${url.username}:${url.password}`
         ).toString('base64')}`,
       }),
-      ...(settings.main.mediaServerType === MediaServerType.EMBY && {
-        'Accept-Encoding': 'gzip',
-      }),
+
       ...options.headers,
     };
 

server/api/indexer.ts

@@ -0,0 +1,30 @@
+import type {
+  TmdbSeasonWithEpisodes,
+  TmdbTvDetails,
+} from '@server/api/themoviedb/interfaces';
+
+export interface TvShowIndexer {
+  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/jellyfin.ts

@@ -1,7 +1,9 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import ExternalAPI from '@server/api/externalapi';
 import { ApiErrorCode } from '@server/constants/error';
+import { MediaServerType } from '@server/constants/server';
 import availabilitySync from '@server/lib/availabilitySync';
+import { getSettings } from '@server/lib/settings';
 import logger from '@server/logger';
 import { ApiError } from '@server/types/error';
 import { getAppVersion } from '@server/utils/appVersion';
@@ -103,12 +105,17 @@ class JellyfinAPI extends ExternalAPI {
       authHeaderVal = `MediaBrowser Client="Jellyseerr", Device="Jellyseerr", DeviceId="${deviceId}", Version="${getAppVersion()}"`;
     }
 
+    const settings = getSettings();
+
     super(
       jellyfinHost,
       {},
       {
         headers: {
           'X-Emby-Authorization': authHeaderVal,
+          ...(settings.main.mediaServerType === MediaServerType.EMBY && {
+            'Accept-Encoding': 'gzip',
+          }),
         },
       }
     );

server/api/metadata.ts

@@ -0,0 +1,36 @@
+import type { TvShowIndexer } from '@server/api/indexer';
+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<TvShowIndexer> => {
+  try {
+    const settings = await getSettings();
+
+    if (!settings.tvdb.apiKey || mediaType == 'movie') {
+      return new TheMovieDb();
+    }
+
+    if (mediaType == 'tv' && settings.metadataType.tv == IndexerType.TVDB) {
+      return await Tvdb.getInstance();
+    }
+
+    if (
+      mediaType == 'anime' &&
+      settings.metadataType.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/themoviedb/index.ts

@@ -1,4 +1,5 @@
 import ExternalAPI from '@server/api/externalapi';
+import type { TvShowIndexer } from '@server/api/indexer';
 import cacheManager from '@server/lib/cache';
 import { sortBy } from 'lodash';
 import type {
@@ -98,7 +99,7 @@ interface DiscoverTvOptions {
   withStatus?: string; // Returning Series: 0 Planned: 1 In Production: 2 Ended: 3 Cancelled: 4 Pilot: 5
 }
 
-class TheMovieDb extends ExternalAPI {
+class TheMovieDb extends ExternalAPI implements TvShowIndexer {
   private discoverRegion?: string;
   private originalLanguage?: string;
   constructor({
@@ -308,6 +309,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 {