@lorenzopant/tmdb 0.0.6 → 0.0.7

package/dist/endpoints/movies.d.ts

@@ -1,8 +1,8 @@
 import { ApiClient } from "../client";
 import { TMDBOptions } from "../tmdb";
 import { Changes } from "../types/common";
-import { MovieAlternativeTitles, MovieCredits, MovieDetails, MovieExternalIDs, MovieImages, MovieKeywords, MovieReleaseDates, MovieResultItem, MovieTranslations, MovieVideos, MovieWatchProvider } from "../types/movies";
-import { MovieAlternativeTitlesParams, MovieChangesParams, MovieCreditsParams, MovieDetailsParams, MovieExternalIDsParams, MovieImagesParams, MovieKeywordsParams, MovieRecommendationsParams, MovieReleaseDatesParams, MovieSimilarParams, MovieTranslationsParams, MovieVideosParams, MovieWathProvidersParams, PaginatedResponse } from "../types/params";
+import { MovieAlternativeTitles, MovieAppendToResponseNamespace, MovieCredits, MovieDetails, MovieDetailsWithAppends, MovieExternalIDs, MovieImages, MovieKeywords, MovieRecommendations, MovieReleaseDates, MovieReviews, MovieSimilar, MovieTranslations, MovieVideos, MovieWatchProvider } from "../types/movies";
+import { MovieAlternativeTitlesParams, MovieChangesParams, MovieCreditsParams, MovieDetailsParams, MovieExternalIDsParams, MovieImagesParams, MovieKeywordsParams, MovieRecommendationsParams, MovieReleaseDatesParams, MovieReviewsParams, MovieSimilarParams, MovieTranslationsParams, MovieVideosParams, MovieWathProvidersParams } from "../types/params";
 export declare const MOVIE_ENDPOINTS: {
     MOVIE: string;
     ALTERNATIVE_TITLES: string;
@@ -18,6 +18,7 @@ export declare const MOVIE_ENDPOINTS: {
     TRANSLATIONS: string;
     VIDEOS: string;
     WATCH_PROVIDERS: string;
+    REVIEWS: string;
 };
 export declare class MoviesAPI {
     private client;
@@ -34,7 +35,9 @@ export declare class MoviesAPI {
      * @returns A promise that resolves to the movie details.
      * @reference https://developer.themoviedb.org/reference/movie-details
      */
-    details(params: MovieDetailsParams): Promise<MovieDetails>;
+    details<T extends readonly MovieAppendToResponseNamespace[] = []>(params: MovieDetailsParams & {
+        append_to_response?: T[number] | T;
+    }): Promise<T extends [] ? MovieDetails : MovieDetailsWithAppends<T>>;
     /**
      * Alternative Titles
      * GET - https://api.themoviedb.org/3/movie/{movie_id}/alternative_titles
@@ -133,7 +136,7 @@ export declare class MoviesAPI {
      * @returns A promise that resolves to a paginated response of similar movies.
      * @reference https://developer.themoviedb.org/reference/movie-recommendations
      */
-    recommendations(params: MovieRecommendationsParams): Promise<PaginatedResponse<MovieResultItem>>;
+    recommendations(params: MovieRecommendationsParams): Promise<MovieRecommendations>;
     /**
      * Release Dates
      * GET - https://api.themoviedb.org/3/movie/{movie_id}/release_dates
@@ -151,6 +154,18 @@ export declare class MoviesAPI {
      * @reference https://developer.themoviedb.org/reference/movie-release-dates
      */
     release_dates(params: MovieReleaseDatesParams): Promise<MovieReleaseDates>;
+    /**
+     * Reviews
+     * GET - https://api.themoviedb.org/3/movie/{movie_id}/reviews
+     *
+     * Get the user reviews for a movie.
+     * @param movie_id The ID of the movie.
+     * @param page Page number of the results to return. Defaults to 1.
+     * @param language Language code to filter the results. Default is "en-US".
+     * @returns A promise that resolves to a paginated response of movies reviews.
+     * @reference https://developer.themoviedb.org/reference/movie-reviews
+     */
+    reviews(params: MovieReviewsParams): Promise<MovieReviews>;
     /**
      * Similar
      * GET -https://api.themoviedb.org/3/movie/{movie_id}/similar
@@ -164,7 +179,7 @@ export declare class MoviesAPI {
      * @returns A promise that resolves to a paginated response of similar movies.
      * @reference https://developer.themoviedb.org/reference/movie-similar
      */
-    similar(params: MovieSimilarParams): Promise<PaginatedResponse<MovieResultItem>>;
+    similar(params: MovieSimilarParams): Promise<MovieSimilar>;
     /**
      * Translations
      * GET - https://api.themoviedb.org/3/movie/{movie_id}/translations

package/dist/endpoints/movies.js

@@ -13,10 +13,10 @@ export const MOVIE_ENDPOINTS = {
     TRANSLATIONS: "/translations",
     VIDEOS: "/videos",
     WATCH_PROVIDERS: "/watch/providers",
+    REVIEWS: "/reviews",
     // Missing:
     // ACCOUNT_STATES
     // LISTS
-    // REVIEWS
     // ADD RATING
     // DELETE RATING
 };
@@ -189,6 +189,22 @@ export class MoviesAPI {
         const endpoint = `${MOVIE_ENDPOINTS.MOVIE}/${params.movie_id}${MOVIE_ENDPOINTS.RELEASE_DATES}`;
         return this.client.request(endpoint);
     }
+    /**
+     * Reviews
+     * GET - https://api.themoviedb.org/3/movie/{movie_id}/reviews
+     *
+     * Get the user reviews for a movie.
+     * @param movie_id The ID of the movie.
+     * @param page Page number of the results to return. Defaults to 1.
+     * @param language Language code to filter the results. Default is "en-US".
+     * @returns A promise that resolves to a paginated response of movies reviews.
+     * @reference https://developer.themoviedb.org/reference/movie-reviews
+     */
+    async reviews(params) {
+        const { language = this.defaultOptions.language, ...rest } = params;
+        const endpoint = `${MOVIE_ENDPOINTS.MOVIE}/${params.movie_id}${MOVIE_ENDPOINTS.REVIEWS}`;
+        return this.client.request(endpoint, { language, ...rest });
+    }
     /**
      * Similar
      * GET -https://api.themoviedb.org/3/movie/{movie_id}/similar

package/dist/tests/movies/movies.integration.test.js

@@ -25,6 +25,15 @@ describe("Movies (integration)", () => {
             expect(error).toBeInstanceOf(TMDBError);
         }
     });
+    it("(MOVIE DETAILS) should get movie details with appended response", async () => {
+        const movie_id = 550; // Fight Club
+        const movie = await tmdb.movies.details({ movie_id, append_to_response: ["reviews"] });
+        expect(movie).toBeDefined();
+        expect(movie.id).toBe(movie_id);
+        expect(movie.title).toBe("Fight Club");
+        expect(movie.reviews.results).toBeDefined();
+        expect(movie.reviews.results.length).toBeGreaterThanOrEqual(0);
+    });
     it("(MOVIE ALTERNATIVE TITLES) should get movie alternative titles", async () => {
         const movie_id = 550; // Fight Club
         const movie_titles = await tmdb.movies.alternative_titles({ movie_id });
@@ -106,6 +115,16 @@ describe("Movies (integration)", () => {
         expect(release_dates.results[0].iso_3166_1).toBeDefined();
         expect(release_dates.results[0].release_dates.length).toBeGreaterThan(0);
     });
+    it("(MOVIE REVIEWS) should get movie reviews", async () => {
+        const movie_id = 550; // Fight Club
+        const reviews = await tmdb.movies.reviews({ movie_id });
+        expect(reviews).toBeDefined();
+        expect(reviews.results.length).toBeGreaterThan(0);
+        expect(reviews.results[0].id).toBeDefined();
+        expect(reviews.page).toBe(1);
+        expect(reviews.total_results).toBeGreaterThan(0);
+        expect(reviews.total_pages).toBeGreaterThan(0);
+    });
     it("(MOVIE SIMILAR) should get similar movies", async () => {
         const movie_id = 550;
         const similar = await tmdb.movies.similar({ movie_id });

package/dist/tests/movies/movies.test.js

@@ -13,9 +13,9 @@ describe("MoviesAPI", () => {
     });
     it("should call client.request with the correct parameters", async () => {
         const movie_id = 550;
-        const append_to_response = ["credits", "images"];
         const language = "en";
-        await moviesAPI.details({ movie_id, append_to_response, language });
+        const append_to_response = ["credits", "images"];
+        await moviesAPI.details({ movie_id, language, append_to_response });
         expect(clientMock.request).toHaveBeenCalledOnce();
         expect(clientMock.request).toHaveBeenCalledWith("/movie/550", {
             movie_id,

package/dist/types/movies.d.ts

@@ -1,5 +1,6 @@
-import { Cast, Collection, Crew, Genre, ImageItem, Keyword, ProductionCompany, ProductionCountry, SpokenLanguage, VideoItem } from "./common";
+import { Cast, Changes, Collection, Crew, Genre, ImageItem, Keyword, ProductionCompany, ProductionCountry, SpokenLanguage, VideoItem } from "./common";
 import { ReleaseType } from "./enums";
+import { PaginatedResponse } from "./params";
 import { ISO3166Country } from "./utility";
 export type MovieDetails = {
     adult: boolean;
@@ -55,6 +56,7 @@ export type MovieAlternativeTitle = {
     iso_3166_1: string;
     type: string;
 };
+export type MovieChanges = Changes;
 export type MovieCredits = {
     id: number;
     cast: Cast[];
@@ -77,6 +79,8 @@ export type MovieImages = {
     logos: ImageItem[];
     posters: ImageItem[];
 };
+export type MovieRecommendations = PaginatedResponse<MovieResultItem>;
+export type MovieSimilar = PaginatedResponse<MovieResultItem>;
 export type MovieReleaseDates = {
     id: number;
     results: MovieReleaseDateResult[];
@@ -93,6 +97,22 @@ export type MovieReleaseDate = {
     note: string;
     descriptors: any[];
 };
+export type MovieReviews = PaginatedResponse<MovieReview>;
+export type MovieReview = {
+    author: string;
+    author_details: MovieReviewAuthorDetails;
+    content: string;
+    created_at: string;
+    id: string;
+    updated_at: string;
+    url: string;
+};
+export type MovieReviewAuthorDetails = {
+    name: string;
+    username: string;
+    avatar_path?: string;
+    rating?: number;
+};
 export type MovieTranslations = {
     id: number;
     translations: MovieTranslationResults[];
@@ -130,3 +150,22 @@ export type WatchProviderItem = {
     provider_name: string;
     display_priority: number;
 };
+/** Append To Response */
+export type MovieAppendToResponseNamespace = "alternative_titles" | "changes" | "credits" | "external_ids" | "images" | "keywords" | "recommendations" | "release_dates" | "reviews" | "similar" | "translations" | "videos";
+export type MovieAppendableMap = {
+    alternative_titles: MovieAlternativeTitles;
+    changes: MovieChanges;
+    credits: MovieCredits;
+    external_ids: MovieExternalIDs;
+    images: MovieImages;
+    keywords: MovieKeywords;
+    recommendations: MovieRecommendations;
+    release_dates: MovieReleaseDates;
+    reviews: MovieReviews;
+    similar: MovieSimilar;
+    translations: MovieTranslations;
+    videos: MovieVideos;
+};
+export type MovieDetailsWithAppends<T extends readonly MovieAppendToResponseNamespace[]> = MovieDetails & {
+    [K in T[number]]: MovieAppendableMap[K];
+};

package/dist/types/params.d.ts

@@ -1,5 +1,6 @@
 import { CountryISO3166_1 } from "./countries";
 import { LanguageISO6391 } from "./lang";
+import { MovieAppendToResponseNamespace } from "./movies";
 export type PaginatedResponse<T> = {
     page: number;
     total_pages: number;
@@ -22,7 +23,7 @@ export type MovieListParams = {
 };
 export type MovieDetailsParams = {
     movie_id: number;
-    append_to_response?: string[];
+    append_to_response?: MovieAppendToResponseNamespace[];
     language?: LanguageISO6391;
 };
 export type MovieAlternativeTitlesParams = {
@@ -58,3 +59,4 @@ export type MovieRecommendationsParams = {
 };
 export type MovieSimilarParams = MovieRecommendationsParams;
 export type MovieVideosParams = MovieCreditsParams;
+export type MovieReviewsParams = MovieRecommendationsParams;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lorenzopant/tmdb",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "A completely type-safe The Movie Database (TMDB) API wrapper for typescript applications.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",