Merge pull request #48 from blakejoy/chore/add-error-res

Feat: Add error response.

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "tmdb-ts",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "tmdb-ts",
-      "version": "1.5.0",
+      "version": "1.6.1",
       "license": "MIT",
       "dependencies": {
         "cross-fetch": "^3.1.4"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tmdb-ts",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "TMDB v3 library wrapper",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/api.ts

@@ -1,5 +1,6 @@
 import fetch from 'cross-fetch';
 import { parseOptions } from './utils';
+import { ErrorResponse } from './types';
 
 const BASE_URL_V3 = 'https://api.themoviedb.org/3';
 
@@ -17,6 +18,11 @@ export class Api {
         'Content-Type': 'application/json;charset=utf-8',
       },
     });
+
+    if (!response.ok) {
+      return Promise.reject((await response.json()) as ErrorResponse);
+    }
+
     return (await response.json()) as T;
   }
 }

src/endpoints/collections.ts

@@ -24,7 +24,10 @@ export class CollectionsEndpoint extends BaseEndpoint {
     );
   }
 
-  async images(id: number, options?: CollectionImageOptions): Promise<ImageCollection> {
+  async images(
+    id: number,
+    options?: CollectionImageOptions
+  ): Promise<ImageCollection> {
     const computedOptions = {
       include_image_language: options?.include_image_language?.join(','),
       language: options?.language,

src/endpoints/movies.ts

@@ -35,7 +35,7 @@ export interface MoviesImageSearchOptions extends LanguageOption {
   /**
    * a list of ISO-639-1 values to query
    */
-  include_image_language?: string[],
+  include_image_language?: string[];
 }
 
 export class MoviesEndpoint extends BaseEndpoint {
@@ -85,12 +85,18 @@ export class MoviesEndpoint extends BaseEndpoint {
     return await this.api.get<ExternalIds>(`${BASE_MOVIE}/${id}/external_ids`);
   }
 
-  async images(id: number, options?: MoviesImageSearchOptions): Promise<Images> {
+  async images(
+    id: number,
+    options?: MoviesImageSearchOptions
+  ): Promise<Images> {
     const computedOptions = {
       include_image_language: options?.include_image_language?.join(','),
       language: options?.language,
     };
-    return await this.api.get<Images>(`${BASE_MOVIE}/${id}/images`, computedOptions);
+    return await this.api.get<Images>(
+      `${BASE_MOVIE}/${id}/images`,
+      computedOptions
+    );
   }
 
   async keywords(id: number): Promise<Keywords> {
@@ -120,11 +126,17 @@ export class MoviesEndpoint extends BaseEndpoint {
     );
   }
 
-  async reviews(id: number, options?: LanguageOption & PageOption): Promise<Reviews> {
+  async reviews(
+    id: number,
+    options?: LanguageOption & PageOption
+  ): Promise<Reviews> {
     return await this.api.get<Reviews>(`${BASE_MOVIE}/${id}/reviews`, options);
   }
 
-  async similar(id: number, options?: LanguageOption & PageOption): Promise<SimilarMovies> {
+  async similar(
+    id: number,
+    options?: LanguageOption & PageOption
+  ): Promise<SimilarMovies> {
     return await this.api.get<SimilarMovies>(
       `${BASE_MOVIE}/${id}/similar`,
       options

src/endpoints/people.ts

@@ -34,7 +34,7 @@ export class PeopleEndpoint extends BaseEndpoint {
       append_to_response: appendToResponse
         ? appendToResponse.join(',')
         : undefined,
-      language: language
+      language: language,
     };
     return await this.api.get<AppendToResponse<PersonDetails, T, 'person'>>(
       `${BASE_PERSON}/${id}`,
@@ -52,21 +52,30 @@ export class PeopleEndpoint extends BaseEndpoint {
     );
   }
 
-  async movieCredits(id: number, options?: LanguageOption): Promise<PersonMovieCredit> {
+  async movieCredits(
+    id: number,
+    options?: LanguageOption
+  ): Promise<PersonMovieCredit> {
     return await this.api.get<PersonMovieCredit>(
       `${BASE_PERSON}/${id}/movie_credits`,
       options
     );
   }
 
-  async tvShowCredits(id: number, options?: LanguageOption): Promise<PersonTvShowCredit> {
+  async tvShowCredits(
+    id: number,
+    options?: LanguageOption
+  ): Promise<PersonTvShowCredit> {
     return await this.api.get<PersonTvShowCredit>(
       `${BASE_PERSON}/${id}/tv_credits`,
       options
     );
   }
 
-  async combinedCredits(id: number, options?: LanguageOption): Promise<PersonCombinedCredits> {
+  async combinedCredits(
+    id: number,
+    options?: LanguageOption
+  ): Promise<PersonCombinedCredits> {
     return await this.api.get<PersonCombinedCredits>(
       `${BASE_PERSON}/${id}/combined_credits`,
       options
@@ -98,7 +107,9 @@ export class PeopleEndpoint extends BaseEndpoint {
     return await this.api.get<PersonDetails>(`${BASE_PERSON}/latest`);
   }
 
-  async popular(options?: LanguageOption & PageOption): Promise<PopularPersons> {
+  async popular(
+    options?: LanguageOption & PageOption
+  ): Promise<PopularPersons> {
     return await this.api.get<PopularPersons>(
       `${BASE_PERSON}/popular`,
       options

src/endpoints/search.ts

@@ -1,6 +1,15 @@
 import { BaseEndpoint } from './base';
 import { MultiSearchResult, Search } from '../types/search';
-import { Collection, Company, LanguageOption, Movie, PageOption, Person, RegionOption, TV } from '../types';
+import {
+  Collection,
+  Company,
+  LanguageOption,
+  Movie,
+  PageOption,
+  Person,
+  RegionOption,
+  TV,
+} from '../types';
 
 const BASE_SEARCH = '/search';
 
@@ -9,27 +18,44 @@ export interface SearchOptions {
   page?: number;
 }
 
-export interface MovieSearchOptions extends SearchOptions, LanguageOption, PageOption, RegionOption {
+export interface MovieSearchOptions
+  extends SearchOptions,
+    LanguageOption,
+    PageOption,
+    RegionOption {
   include_adult?: boolean;
   year?: number;
   primary_release_year?: number;
 }
 
-export interface CollectionSearchOptions extends SearchOptions, LanguageOption, PageOption, RegionOption {
+export interface CollectionSearchOptions
+  extends SearchOptions,
+    LanguageOption,
+    PageOption,
+    RegionOption {
   include_adult?: boolean;
 }
 
-export interface TvSearchOptions extends SearchOptions, LanguageOption, PageOption {
+export interface TvSearchOptions
+  extends SearchOptions,
+    LanguageOption,
+    PageOption {
   include_adult?: boolean;
   year?: number;
   first_air_date_year?: number;
 }
 
-export interface PeopleSearchOptions extends SearchOptions, LanguageOption, PageOption {
+export interface PeopleSearchOptions
+  extends SearchOptions,
+    LanguageOption,
+    PageOption {
   include_adult?: boolean;
 }
 
-export interface MultiSearchOptions extends SearchOptions, LanguageOption, PageOption {
+export interface MultiSearchOptions
+  extends SearchOptions,
+    LanguageOption,
+    PageOption {
   include_adult?: boolean;
 }
 

src/endpoints/trending.ts

@@ -1,4 +1,9 @@
-import { TrendingMediaType, TimeWindow, TrendingResults, LanguageOption } from '../types';
+import {
+  TrendingMediaType,
+  TimeWindow,
+  TrendingResults,
+  LanguageOption,
+} from '../types';
 import { BaseEndpoint } from './base';
 
 export class TrendingEndpoint extends BaseEndpoint {

src/endpoints/tv-episode.ts

@@ -8,7 +8,6 @@ import {
   Images,
   TvEpisodeTranslations,
   Videos,
-  AppendToResponseMovieKey,
   AppendToResponse,
   Changes,
   TvEpisodeChangeValue,
@@ -24,14 +23,14 @@ export interface TvEpisodeImageSearchOptions extends LanguageOption {
   /**
    * a list of ISO-639-1 values to query
    */
-  include_image_language?: string[],
+  include_image_language?: string[];
 }
 
 export interface TvEpisodeVideoSearchOptions extends LanguageOption {
   /**
    * a list of ISO-639-1 values to query
    */
-  include_video_language?: string[],
+  include_video_language?: string[];
 }
 
 export class TvEpisodesEndpoint extends BaseEndpoint {
@@ -76,7 +75,10 @@ export class TvEpisodesEndpoint extends BaseEndpoint {
     );
   }
 
-  async images(episodeSelection: EpisodeSelection, options?: TvEpisodeImageSearchOptions) {
+  async images(
+    episodeSelection: EpisodeSelection,
+    options?: TvEpisodeImageSearchOptions
+  ) {
     const computedOptions = {
       include_image_language: options?.include_image_language?.join(','),
       language: options?.language,
@@ -93,7 +95,10 @@ export class TvEpisodesEndpoint extends BaseEndpoint {
     );
   }
 
-  async videos(episodeSelection: EpisodeSelection, options?: TvEpisodeVideoSearchOptions) {
+  async videos(
+    episodeSelection: EpisodeSelection,
+    options?: TvEpisodeVideoSearchOptions
+  ) {
     const computedOptions = {
       include_video_language: options?.include_video_language?.join(','),
       language: options?.language,

src/endpoints/tv-seasons.ts

@@ -24,14 +24,14 @@ export interface TvSeasonImageSearchOptions extends LanguageOption {
   /**
    * a list of ISO-639-1 values to query
    */
-  include_image_language?: string[],
+  include_image_language?: string[];
 }
 
 export interface TvSeasonVideoSearchOptions extends LanguageOption {
   /**
    * a list of ISO-639-1 values to query
    */
-  include_video_language?: string[],
+  include_video_language?: string[];
 }
 
 export class TvSeasonsEndpoint extends BaseEndpoint {
@@ -91,7 +91,10 @@ export class TvSeasonsEndpoint extends BaseEndpoint {
     );
   }
 
-  async images(seasonSelection: SeasonSelection, options?: TvSeasonImageSearchOptions) {
+  async images(
+    seasonSelection: SeasonSelection,
+    options?: TvSeasonImageSearchOptions
+  ) {
     const computedOptions = {
       include_image_language: options?.include_image_language?.join(','),
       language: options?.language,
@@ -102,7 +105,10 @@ export class TvSeasonsEndpoint extends BaseEndpoint {
     );
   }
 
-  async videos(seasonSelection: SeasonSelection, options?: TvSeasonVideoSearchOptions) {
+  async videos(
+    seasonSelection: SeasonSelection,
+    options?: TvSeasonVideoSearchOptions
+  ) {
     const computedOptions = {
       include_video_language: options?.include_video_language?.join(','),
       language: options?.language,

src/endpoints/tv-shows.ts

@@ -80,7 +80,10 @@ export class TvShowsEndpoint extends BaseEndpoint {
     );
   }
 
-  async aggregateCredits(id: number, options?: LanguageOption): Promise<AggregateCredits> {
+  async aggregateCredits(
+    id: number,
+    options?: LanguageOption
+  ): Promise<AggregateCredits> {
     return await this.api.get<AggregateCredits>(
       `${BASE_TV}/${id}/aggregate_credits`,
       options
@@ -110,7 +113,10 @@ export class TvShowsEndpoint extends BaseEndpoint {
       include_image_language: options?.include_image_language?.join(','),
       language: options?.language,
     };
-    return await this.api.get<Images>(`${BASE_TV}/${id}/images`, computedOptions);
+    return await this.api.get<Images>(
+      `${BASE_TV}/${id}/images`,
+      computedOptions
+    );
   }
 
   async keywords(id: number): Promise<Keywords> {
@@ -127,7 +133,10 @@ export class TvShowsEndpoint extends BaseEndpoint {
     );
   }
 
-  async reviews(id: number, options?: LanguageOption & PageOption): Promise<Reviews> {
+  async reviews(
+    id: number,
+    options?: LanguageOption & PageOption
+  ): Promise<Reviews> {
     return await this.api.get<Reviews>(`${BASE_TV}/${id}/reviews`, options);
   }
 
@@ -137,7 +146,10 @@ export class TvShowsEndpoint extends BaseEndpoint {
     );
   }
 
-  async similar(id: number, options?: LanguageOption & PageOption): Promise<SimilarTvShows> {
+  async similar(
+    id: number,
+    options?: LanguageOption & PageOption
+  ): Promise<SimilarTvShows> {
     return await this.api.get<SimilarTvShows>(
       `${BASE_TV}/${id}/similar`,
       options
@@ -153,7 +165,10 @@ export class TvShowsEndpoint extends BaseEndpoint {
       include_video_language: options?.include_video_language?.join(','),
       language: options?.language,
     };
-    return await this.api.get<Videos>(`${BASE_TV}/${id}/videos`, computedOptions);
+    return await this.api.get<Videos>(
+      `${BASE_TV}/${id}/videos`,
+      computedOptions
+    );
   }
 
   /**

src/types/collections.ts

@@ -19,5 +19,5 @@ export interface CollectionImageOptions extends LanguageOption {
   /**
    * a list of ISO-639-1 values to query
    */
-  include_image_language?: string[],
-}
+  include_image_language?: string[];
+}

src/types/index.ts

@@ -19,6 +19,12 @@ export * from './collections';
 export * from './tv-episode';
 export * from './tv-seasons';
 
+export interface ErrorResponse {
+  status_code: number;
+  status_message: string;
+  success: boolean;
+}
+
 export type MediaType = 'movie' | 'tv' | 'person';
 
 export interface AuthorDetails {

src/types/tv-shows.ts

@@ -279,12 +279,12 @@ export interface TvShowImageOptions extends LanguageOption {
   /**
    * a list of ISO-639-1 values to query
    */
-  include_image_language?: string[],
+  include_image_language?: string[];
 }
 
 export interface TvShowVideoOptions extends LanguageOption {
   /**
    * a list of ISO-639-1 values to query
    */
-  include_video_language?: string[],
-}
+  include_video_language?: string[];
+}