feat(tmdb): create v4 endpoint

Author: dvcol

scripts/manifest.ts

@@ -7,8 +7,15 @@ import { getDirName, isDev, port, resolveParent } from './utils';
 import type { Manifest } from 'webextension-polyfill';
 
 export const Endpoints = {
-  Production: 'https://api.trakt.tv',
-  Staging: 'https://api-staging.trakt.tv',
+  trakt: {
+    Production: 'https://api.trakt.tv',
+    Staging: 'https://api-staging.trakt.tv',
+  },
+  tvdb: 'https://api4.thetvdb.co',
+  tmdb: {
+    api: 'https://api.themoviedb.org',
+    redirect: 'https://www.themoviedb.org',
+  },
 } as const;
 
 export const manifest: Manifest.WebExtensionManifest = {
@@ -38,10 +45,10 @@ export const manifest: Manifest.WebExtensionManifest = {
   web_accessible_resources: [
     {
       resources: ['/views/options/index.html'],
-      matches: [`${Endpoints.Production}/*`, `${Endpoints.Staging}/*`],
+      matches: [`${Endpoints.trakt.Production}/*`, `${Endpoints.trakt.Staging}/*`, `${Endpoints.tvdb}/*`, `${Endpoints.tmdb.redirect}/*`],
     },
   ],
-  host_permissions: [`${Endpoints.Production}/*`, `${Endpoints.Staging}/*`],
+  host_permissions: [`${Endpoints.trakt.Production}/*`, `${Endpoints.trakt.Staging}/*`, `${Endpoints.tvdb}/*`, `${Endpoints.tmdb.api}/*`],
   content_security_policy: {
     // Adds localhost for vite hot reload
     extension_pages: isDev

src/models/tmdb/tmdb-client.model.ts

@@ -47,11 +47,13 @@ export type TmdbApiPagination = {
   total_results?: number;
 };
 
-export type TmdbApiResponsePageData<T = unknown> = TmdbApiPagination & {
-  results: T[];
-};
+export type TmdbApiResponsePageData<T = unknown, C = Record<string, string>> = Partial<TmdbApiResponseData> &
+  TmdbApiPagination & {
+    results: T[];
+  } & C;
 
-export type TmdbPaginatedData<T = unknown> = {
+export type TmdbPaginatedData<T = unknown, C = unknown> = {
+  common?: C;
   data: T[];
   pagination: TmdbApiPagination;
 };
@@ -62,6 +64,8 @@ export type TmdbApiQuery<T = unknown> = BaseQuery<BaseRequest, T>;
 export type TmdbApiTemplateOptions = BaseTemplateOptions & {
   /** If the method requires user authentication */
   auth?: boolean;
+  /** The api version (3 or 4) */
+  version: number | string;
 };
 
 export type TmdbApiTemplate<Parameter extends TmdbApiParam = TmdbApiParam> = BaseTemplate<Parameter, TmdbApiTemplateOptions>;

src/models/tmdb/tmdb-entity.model.ts

@@ -57,3 +57,9 @@ export type TmdbKeyword = {
   id: number;
   name: string;
 };
+
+export type TmdbAccountRating = {
+  /** Creation timestamp in ISO 8601 format (YYYY-MM-DD'T'hh:mm:ss.sssZ) */
+  created_at: string;
+  value: number;
+};

src/models/tmdb/tmdb-list.model.ts

@@ -1,24 +1,43 @@
-export type TmdbList = {
-  account_object_id: string;
-  adult: number;
-  average_rating: number;
-  backdrop_path: string;
-  /** UTC date when the list was created (YYYY-MM-DD HH:mm:ss UTC) */
-  created_at: string;
-  description: string;
-  featured: number;
+import type { TmdbUser } from '~/models/tmdb/tmdb-user.model';
+
+type BaseTmdbList = {
   id: number;
   /** The ISO 3166-1 code of the country */
   iso_3166_1: string;
   /** The ISO 639-1 code of the language */
   iso_639_1: string;
   name: string;
-  number_of_items: number;
+  average_rating: number;
+  description: string;
   poster_path: string;
+  backdrop_path: string;
   public: number;
   revenue: number;
   runtime: string;
   sort_by: number;
+};
+
+export type TmdbAccountListV4 = BaseTmdbList & {
+  account_object_id: string;
+  adult: number;
+  /** UTC date when the list was created (YYYY-MM-DD HH:mm:ss UTC) */
+  created_at: string;
+  featured: number;
+  number_of_items: number;
+  sort_by: number;
   /** UTC date when the list was updated (YYYY-MM-DD HH:mm:ss UTC) */
   updated_at: string;
 };
+
+export type TmdbListV4 = BaseTmdbList & {
+  comments: Record<string, string>;
+  created_by: TmdbUser;
+  item_count: number;
+  object_ids: Record<string, string>;
+  sort_by: string;
+
+  // page: number;
+  // results: TmdbMovieShort[];
+  // total_pages: number;
+  // total_results: number;
+};

src/models/tmdb/tmdb-movie.model.ts

@@ -1,7 +1,17 @@
 import type { TmdbCollection } from '~/models/tmdb/tmdb-collection.model';
-import type { EntityTypes, Extended, Short, TmdbCompany, TmdbCountry, TmdbGenre, TmdbLanguage } from '~/models/tmdb/tmdb-entity.model';
+import type {
+  EntityTypes,
+  Extended,
+  Short,
+  TmdbAccountRating,
+  TmdbCompany,
+  TmdbCountry,
+  TmdbGenre,
+  TmdbLanguage,
+} from '~/models/tmdb/tmdb-entity.model';
 
 export type TmdbMovieShort = {
+  media_type?: 'movie';
   adult: boolean;
   backdrop_path: string;
   genre_ids: number[];
@@ -39,3 +49,7 @@ export type TmdbMovie<T extends EntityTypes = Short> = T extends Extended
   : T extends Short
     ? TmdbMovieShort
     : TmdbMovieShort | TmdbMovieExtended;
+
+export type TmdbMovieRating = TmdbMovie & {
+  account_rating: TmdbAccountRating;
+};

src/models/tmdb/tmdb-show.model.ts

@@ -1,4 +1,14 @@
-import type { EntityTypes, Extended, Short, TmdbCompany, TmdbCountry, TmdbGenre, TmdbLanguage, TmdbNetwork } from '~/models/tmdb/tmdb-entity.model';
+import type {
+  EntityTypes,
+  Extended,
+  Short,
+  TmdbAccountRating,
+  TmdbCompany,
+  TmdbCountry,
+  TmdbGenre,
+  TmdbLanguage,
+  TmdbNetwork,
+} from '~/models/tmdb/tmdb-entity.model';
 import type { TmdbEpisode } from '~/models/tmdb/tmdb-episode.model';
 import type { TmdbSeason } from '~/models/tmdb/tmdb-season.model';
 
@@ -11,6 +21,7 @@ export type TmdbPersonShow = {
 };
 
 export type TmdbShowShort = {
+  media_type?: 'tv';
   adult: boolean;
   backdrop_path: string;
   genre_ids: number[];
@@ -55,3 +66,7 @@ export type TmdbShow<T extends EntityTypes = Short> = T extends Extended
   : T extends Short
     ? TmdbShowShort
     : TmdbShowShort | TmdbShowExtended;
+
+export type TmdbShowRating = TmdbShowShort & {
+  account_rating: TmdbAccountRating;
+};

src/models/tmdb/tmdb-user.model.ts

@@ -0,0 +1,7 @@
+export type TmdbUser = {
+  id: string;
+  name: string;
+  username: string;
+  avatar_path: string;
+  gravatar_hash: string;
+};

src/services/common/base-client.test.ts

@@ -332,7 +332,7 @@ describe('base-client.ts', () => {
       it('should ignore cache if cache expired using store retention', async () => {
         expect.assertions(2);
 
-        const _cacheStore: CacheStore = new Map();
+        const _cacheStore: CacheStore<Response> = new Map();
         _cacheStore.retention = 15;
         const _client = new TestableBaseClient({ cacheStore: _cacheStore });