@lorenzopant/tmdb 0.0.6 → 0.0.8

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+pnpm run lint
+pnpm test

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/errors/tmdb.d.ts

@@ -5,11 +5,11 @@
  * @property status_code - The numeric code representing the type of error encountered.
  * @property status_message - A descriptive message providing details about the error.
  */
-export type TMDBAPIErrorResponse = {
+export interface TMDBAPIErrorResponse {
     success: boolean;
     status_code: number;
     status_message: string;
-};
+}
 /**
  * Represents a generic error or an error specific to the TMDB (The Movie Database) API.
  * This error class extends the built-in `Error` class and includes additional

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/tmdb.d.ts

@@ -3,7 +3,7 @@ import { MoviesAPI } from "./endpoints/movies";
 import { SearchAPI } from "./endpoints/search";
 import { CountryISO3166_1 } from "./types/countries";
 import { LanguageISO6391 } from "./types/lang";
-export type TMDBOptions = {
+export interface TMDBOptions {
     /**
      * The language to use for requests (ISO 639-1 code)
      * This provides localization and translated data.
@@ -16,7 +16,7 @@ export type TMDBOptions = {
      * If not set, TMDB may fall back to a default or global data.
      */
     region?: CountryISO3166_1;
-};
+}
 export declare class TMDB {
     private client;
     private options;

package/dist/types/common.d.ts

@@ -1,47 +1,47 @@
 /**
  * Represents a genre of a movie or TV show.
  */
-export type Genre = {
+export interface Genre {
     id: number;
     name: string;
-};
+}
 /**
  * Represents a production company involved in creating a movie or TV show.
  */
-export type ProductionCompany = {
+export interface ProductionCompany {
     id: number;
     logo_path: string | null;
     name: string;
     origin_country: string;
-};
+}
 /**
  * Represents a country where a movie or TV show was produced.
  */
-export type ProductionCountry = {
+export interface ProductionCountry {
     iso_3166_1: string;
     name: string;
-};
+}
 /**
  * Represents a spoken language in a movie or TV show.
  */
-export type SpokenLanguage = {
+export interface SpokenLanguage {
     english_name: string;
     iso_639_1: string;
     name: string;
-};
+}
 /**
  * Represents a collection of movies.
  */
-export type Collection = {
+export interface Collection {
     id: number;
     name: string;
     poster_path: string | null;
     backdrop_path: string | null;
-};
+}
 /**
  * Represents a cast member in a movie or TV show.
  */
-export type Cast = {
+export interface Cast {
     adult: boolean;
     gender: number | null;
     id: number;
@@ -54,11 +54,11 @@ export type Cast = {
     character: string;
     credit_id: string;
     order: number;
-};
+}
 /**
  * Represents a crew member in a movie or TV show.
  */
-export type Crew = {
+export interface Crew {
     adult: boolean;
     gender: number | null;
     id: number;
@@ -70,27 +70,27 @@ export type Crew = {
     credit_id: string;
     department: string;
     job: string;
-};
-export type Keyword = {
+}
+export interface Keyword {
     id: number;
     name: string;
-};
-export type Changes = {
+}
+export interface Changes {
     changes: Change[];
-};
-export type Change = {
+}
+export interface Change {
     key: string;
     items: ChangeItem[];
-};
-export type ChangeItem = {
+}
+export interface ChangeItem {
     id: number;
     action: string;
     time: string;
     iso_639_1: string;
     iso_3166_1: string;
     value: any;
-};
-export type ImageItem = {
+}
+export interface ImageItem {
     aspect_ratio: number;
     height: number;
     iso_639_1: string | null;
@@ -98,8 +98,8 @@ export type ImageItem = {
     vote_average: number;
     vote_count: number;
     width: number;
-};
-export type VideoItem = {
+}
+export interface VideoItem {
     iso_649_1: string;
     iso_3166_1: string;
     name: string;
@@ -110,4 +110,4 @@ export type VideoItem = {
     official: boolean;
     published_at: string;
     id: string;
-};
+}

package/dist/types/movies.d.ts

@@ -1,7 +1,8 @@
-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 = {
+export interface MovieDetails {
     adult: boolean;
     backdrop_path: string | null;
     belongs_to_collection: Collection | null;
@@ -28,8 +29,8 @@ export type MovieDetails = {
     video: boolean;
     vote_average: number;
     vote_count: number;
-};
-export type MovieResultItem = {
+}
+export interface MovieResultItem {
     backdrop_path: string;
     id: number;
     title: string;
@@ -45,59 +46,78 @@ export type MovieResultItem = {
     video: boolean;
     vote_average: number;
     vote_count: number;
-};
-export type MovieAlternativeTitles = {
+}
+export interface MovieAlternativeTitles {
     id: number;
     titles: MovieAlternativeTitle[];
-};
-export type MovieAlternativeTitle = {
+}
+export interface MovieAlternativeTitle {
     title: string;
     iso_3166_1: string;
     type: string;
-};
-export type MovieCredits = {
+}
+export type MovieChanges = Changes;
+export interface MovieCredits {
     id: number;
     cast: Cast[];
     crew: Crew[];
-};
-export type MovieExternalIDs = {
+}
+export interface MovieExternalIDs {
     id: number;
     imdb_id: string | null;
     facebook_id: string | null;
     twitter_id: string | null;
     instagram_id: string | null;
-};
-export type MovieKeywords = {
+}
+export interface MovieKeywords {
     id: number;
     keywords: Keyword[];
-};
-export type MovieImages = {
+}
+export interface MovieImages {
     id: number;
     backdrops: ImageItem[];
     logos: ImageItem[];
     posters: ImageItem[];
-};
-export type MovieReleaseDates = {
+}
+export type MovieRecommendations = PaginatedResponse<MovieResultItem>;
+export type MovieSimilar = PaginatedResponse<MovieResultItem>;
+export interface MovieReleaseDates {
     id: number;
     results: MovieReleaseDateResult[];
-};
-export type MovieReleaseDateResult = {
+}
+export interface MovieReleaseDateResult {
     iso_3166_1: string;
     release_dates: MovieReleaseDate[];
-};
-export type MovieReleaseDate = {
+}
+export interface MovieReleaseDate {
     certification: string;
     iso_639_1: string;
     release_date: string;
     type: ReleaseType | number;
     note: string;
     descriptors: any[];
-};
-export type MovieTranslations = {
+}
+export type MovieReviews = PaginatedResponse<MovieReview>;
+export interface MovieReview {
+    author: string;
+    author_details: MovieReviewAuthorDetails;
+    content: string;
+    created_at: string;
+    id: string;
+    updated_at: string;
+    url: string;
+}
+export interface MovieReviewAuthorDetails {
+    name: string;
+    username: string;
+    avatar_path?: string;
+    rating?: number;
+}
+export interface MovieTranslations {
     id: number;
     translations: MovieTranslationResults[];
-};
-export type MovieTranslationResults = {
+}
+export interface MovieTranslationResults {
     iso_3166_1: string;
     iso_639_1: string;
     name: string;
@@ -109,24 +129,43 @@ export type MovieTranslationResults = {
         tagline: string;
         title: string;
     };
-};
-export type MovieVideos = {
+}
+export interface MovieVideos {
     id: number;
     results: VideoItem[];
-};
-export type MovieWatchProvider = {
+}
+export interface MovieWatchProvider {
     id: number;
     results: Record<ISO3166Country, WatchProvider[]>;
-};
-export type WatchProvider = {
+}
+export interface WatchProvider {
     link: string;
     flatrate: WatchProviderItem[];
     rent: WatchProviderItem[];
     buy: WatchProviderItem[];
-};
-export type WatchProviderItem = {
+}
+export interface WatchProviderItem {
     logo_path: string;
     provider_id: number;
     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 interface 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,12 +1,13 @@
 import { CountryISO3166_1 } from "./countries";
 import { LanguageISO6391 } from "./lang";
-export type PaginatedResponse<T> = {
+import { MovieAppendToResponseNamespace } from "./movies";
+export interface PaginatedResponse<T> {
     page: number;
     total_pages: number;
     total_results: number;
     results: T[];
-};
-export type SearchMoviesParams = {
+}
+export interface SearchMoviesParams {
     query: string;
     include_adult?: boolean;
     language?: LanguageISO6391;
@@ -14,47 +15,48 @@ export type SearchMoviesParams = {
     primary_release_year?: string;
     region?: CountryISO3166_1;
     year?: string;
-};
-export type MovieListParams = {
+}
+export interface MovieListParams {
     language?: LanguageISO6391;
     page?: number;
     region?: CountryISO3166_1;
-};
-export type MovieDetailsParams = {
+}
+export interface MovieDetailsParams {
     movie_id: number;
-    append_to_response?: string[];
+    append_to_response?: MovieAppendToResponseNamespace[];
     language?: LanguageISO6391;
-};
-export type MovieAlternativeTitlesParams = {
+}
+export interface MovieAlternativeTitlesParams {
     movie_id: number;
     country?: CountryISO3166_1;
-};
-export type MovieCreditsParams = {
+}
+export interface MovieCreditsParams {
     movie_id: number;
     language?: LanguageISO6391;
-};
-export type MovieKeywordsParams = {
+}
+export interface MovieKeywordsParams {
     movie_id: number;
-};
+}
 export type MovieExternalIDsParams = MovieKeywordsParams;
 export type MovieReleaseDatesParams = MovieKeywordsParams;
 export type MovieTranslationsParams = MovieKeywordsParams;
 export type MovieWathProvidersParams = MovieKeywordsParams;
-export type MovieChangesParams = {
+export interface MovieChangesParams {
     movie_id: number;
     page?: number;
     start_date?: string;
     end_date?: string;
-};
-export type MovieImagesParams = {
+}
+export interface MovieImagesParams {
     movie_id: number;
     language?: LanguageISO6391;
     include_image_language?: LanguageISO6391;
-};
-export type MovieRecommendationsParams = {
+}
+export interface MovieRecommendationsParams {
     movie_id: number;
     page?: number;
     language?: LanguageISO6391;
-};
+}
 export type MovieSimilarParams = MovieRecommendationsParams;
 export type MovieVideosParams = MovieCreditsParams;
+export type MovieReviewsParams = MovieRecommendationsParams;

package/eslint.config.mjs

@@ -0,0 +1,6 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(eslint.configs.recommended, tseslint.configs.strict, { ignores: ["dist/**", "node_modules"] });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lorenzopant/tmdb",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "A completely type-safe The Movie Database (TMDB) API wrapper for typescript applications.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,23 +17,33 @@
     "movies"
   ],
   "devDependencies": {
+    "@eslint/compat": "^1.3.1",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.30.0",
     "@types/node": "^22.15.2",
+    "@typescript-eslint/eslint-plugin": "^8.35.0",
+    "@typescript-eslint/parser": "^8.35.0",
     "@vitest/coverage-v8": "^3.1.2",
     "@vitest/ui": "^3.1.2",
     "dotenv": "^16.5.0",
+    "eslint": "^9.30.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-import": "^2.32.0",
+    "husky": "^9.1.7",
+    "pino": "^9.7.0",
     "release-it": "^19.0.3",
     "release-it-pnpm": "^4.6.6",
     "typescript": "^5.8.3",
+    "typescript-eslint": "^8.35.0",
+    "vite": "^7.0.0",
     "vitest": "^3.2.4"
   },
-  "dependencies": {
-    "vite": "^7.0.0"
-  },
   "scripts": {
     "build": "tsc",
     "build:watch": "tsc --watch",
     "test": "vitest",
     "test:ui": "vitest --ui",
-    "test:coverage": "vitest --coverage"
+    "test:coverage": "vitest --coverage",
+    "lint": "eslint ."
   }
 }

package/vitest.config.mts

@@ -1,4 +1,3 @@
-import { loadEnvFile } from "process";
 import { defineConfig } from "vitest/config";
 import { loadEnv } from "vite";