@lorenzopant/tmdb 0.0.3 → 0.0.5

package/dist/endpoints/movie_lists.d.ts

@@ -1,15 +1,21 @@
 import { ApiClient } from "../client";
 import { MovieResultItem } from "../types/movies";
-import { PaginatedResponse } from "../types/params";
+import { MovieListParams, PaginatedResponse } from "../types/params";
+import { TMDBOptions } from "../tmdb";
+export declare enum MovieListEndpoints {
+    NOW_PLAYING = "/now_playing",
+    POPULAR = "/popular",
+    TOP_RATED = "/top_rated",
+    UPCOMING = "/upcoming"
+}
 export declare class MovieListsAPI {
     private client;
-    constructor(client: ApiClient);
+    private defaultOptions;
+    constructor(client: ApiClient, defaultOptions?: TMDBOptions);
     /**
      * Fetch Movie List Wrapper
      * @param endpoint Endpoint to call
-     * @param language Language (Defaults to en-US)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
+     * @param params Params for the request (language, page, region, etc)
      * @returns Specific to endpoint (MovieListResult)
      */
     private fetch_movie_list;
@@ -18,39 +24,39 @@ export declare class MovieListsAPI {
      * GET - https://api.themoviedb.org/3/movie/now_playing
      *
      * Get a list of movies that are currently in theatres.
-     * @param language Language (Defaults to en-US)
+     * @param language Language (Defaults to en-US or TMDB default)
      * @param page Page (Defaults to 1)
      * @param region ISO-3166-1 code
      */
-    now_playing(language?: string, page?: number, region?: string): Promise<PaginatedResponse<MovieResultItem>>;
+    now_playing(params?: MovieListParams): Promise<PaginatedResponse<MovieResultItem>>;
     /**
      * Popular
      * GET - https://api.themoviedb.org/3/movie/popular
      *
      * Get a list of movies ordered by popularity.
-     * @param language Language (Defaults to en-US)
+     * @param language Language (Defaults to en-US or TMDB default)
      * @param page Page (Defaults to 1)
      * @param region ISO-3166-1 code
      */
-    popular(language?: string, page?: number, region?: string): Promise<PaginatedResponse<MovieResultItem>>;
+    popular(params?: MovieListParams): Promise<PaginatedResponse<MovieResultItem>>;
     /**
      * Top Rated
      * GET - https://api.themoviedb.org/3/movie/top_rated
      *
      * Get a list of movies ordered by rating.
-     * @param language Language (Defaults to en-US)
+     * @param language Language (Defaults to en-US or TMDB default)
      * @param page Page (Defaults to 1)
      * @param region ISO-3166-1 code
      */
-    top_rated(language?: string, page?: number, region?: string): Promise<PaginatedResponse<MovieResultItem>>;
+    top_rated(params?: MovieListParams): Promise<PaginatedResponse<MovieResultItem>>;
     /**
      * Upcoming
      * GET - https://api.themoviedb.org/3/movie/upcoming
      *
      * Get a list of movies that are being released soon.
-     * @param language Language (Defaults to en-US)
+     * @param language Language (Defaults to en-US or TMDB default)
      * @param page Page (Defaults to 1)
      * @param region ISO-3166-1 code
      */
-    upcoming(language?: string, page?: number, region?: string): Promise<PaginatedResponse<MovieResultItem>>;
+    upcoming(params?: MovieListParams): Promise<PaginatedResponse<MovieResultItem>>;
 }

package/dist/endpoints/movie_lists.js

@@ -1,73 +1,74 @@
 import { MOVIE_ENDPOINTS } from "./movies";
-const MOVIE_LISTS_ENDPOINTS = {
-    NOW_PLAYING: "/now_playing",
-    POPULAR: "/popular",
-    TOP_RATED: "/top_rated",
-    UPCOMING: "/upcoming",
-};
+export var MovieListEndpoints;
+(function (MovieListEndpoints) {
+    MovieListEndpoints["NOW_PLAYING"] = "/now_playing";
+    MovieListEndpoints["POPULAR"] = "/popular";
+    MovieListEndpoints["TOP_RATED"] = "/top_rated";
+    MovieListEndpoints["UPCOMING"] = "/upcoming";
+})(MovieListEndpoints || (MovieListEndpoints = {}));
 export class MovieListsAPI {
     client;
-    constructor(client) {
+    defaultOptions;
+    constructor(client, defaultOptions = {}) {
         this.client = client;
+        this.defaultOptions = defaultOptions;
     }
     /**
      * Fetch Movie List Wrapper
      * @param endpoint Endpoint to call
-     * @param language Language (Defaults to en-US)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
+     * @param params Params for the request (language, page, region, etc)
      * @returns Specific to endpoint (MovieListResult)
      */
-    fetch_movie_list(endpoint, language, page, region) {
-        const params = { page, language, region };
-        return this.client.request(MOVIE_ENDPOINTS.MOVIE + endpoint, params);
+    fetch_movie_list(endpoint, params = {}) {
+        const mergedParams = { ...this.defaultOptions, ...params };
+        return this.client.request(MOVIE_ENDPOINTS.MOVIE + endpoint, mergedParams);
     }
     /**
      * Now Playing
      * GET - https://api.themoviedb.org/3/movie/now_playing
      *
      * Get a list of movies that are currently in theatres.
-     * @param language Language (Defaults to en-US)
+     * @param language Language (Defaults to en-US or TMDB default)
      * @param page Page (Defaults to 1)
      * @param region ISO-3166-1 code
      */
-    async now_playing(language = "en-US", page = 1, region) {
-        return this.fetch_movie_list(MOVIE_LISTS_ENDPOINTS.NOW_PLAYING, language, page, region);
+    async now_playing(params = {}) {
+        return this.fetch_movie_list(MovieListEndpoints.NOW_PLAYING, params);
     }
     /**
      * Popular
      * GET - https://api.themoviedb.org/3/movie/popular
      *
      * Get a list of movies ordered by popularity.
-     * @param language Language (Defaults to en-US)
+     * @param language Language (Defaults to en-US or TMDB default)
      * @param page Page (Defaults to 1)
      * @param region ISO-3166-1 code
      */
-    async popular(language = "en-US", page = 1, region) {
-        return this.fetch_movie_list(MOVIE_LISTS_ENDPOINTS.POPULAR, language, page, region);
+    async popular(params = {}) {
+        return this.fetch_movie_list(MovieListEndpoints.POPULAR, params);
     }
     /**
      * Top Rated
      * GET - https://api.themoviedb.org/3/movie/top_rated
      *
      * Get a list of movies ordered by rating.
-     * @param language Language (Defaults to en-US)
+     * @param language Language (Defaults to en-US or TMDB default)
      * @param page Page (Defaults to 1)
      * @param region ISO-3166-1 code
      */
-    async top_rated(language = "en-US", page = 1, region) {
-        return this.fetch_movie_list(MOVIE_LISTS_ENDPOINTS.TOP_RATED, language, page, region);
+    async top_rated(params = {}) {
+        return this.fetch_movie_list(MovieListEndpoints.TOP_RATED, params);
     }
     /**
      * Upcoming
      * GET - https://api.themoviedb.org/3/movie/upcoming
      *
      * Get a list of movies that are being released soon.
-     * @param language Language (Defaults to en-US)
+     * @param language Language (Defaults to en-US or TMDB default)
      * @param page Page (Defaults to 1)
      * @param region ISO-3166-1 code
      */
-    async upcoming(language = "en-US", page = 1, region) {
-        return this.fetch_movie_list(MOVIE_LISTS_ENDPOINTS.UPCOMING, language, page, region);
+    async upcoming(params = {}) {
+        return this.fetch_movie_list(MovieListEndpoints.UPCOMING, params);
     }
 }

package/dist/endpoints/movies.d.ts

@@ -1,7 +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 { PaginatedResponse } from "../types/params";
+import { MovieAlternativeTitlesParams, MovieDetailsParams, PaginatedResponse } from "../types/params";
 export declare const MOVIE_ENDPOINTS: {
     MOVIE: string;
     ALTERNATIVE_TITLES: string;
@@ -20,7 +21,8 @@ export declare const MOVIE_ENDPOINTS: {
 };
 export declare class MoviesAPI {
     private client;
-    constructor(client: ApiClient);
+    private defaultOptions;
+    constructor(client: ApiClient, options?: TMDBOptions);
     /**
      * Details
      * GET - https://api.themoviedb.org/3/movie/{movie_id}
@@ -32,7 +34,7 @@ export declare class MoviesAPI {
      * @returns A promise that resolves to the movie details.
      * @reference https://developer.themoviedb.org/reference/movie-details
      */
-    details(movie_id: number, append_to_response?: string[], language?: string): Promise<MovieDetails>;
+    details(params: MovieDetailsParams): Promise<MovieDetails>;
     /**
      * Alternative Titles
      * GET - https://api.themoviedb.org/3/movie/{movie_id}/alternative_titles
@@ -43,7 +45,7 @@ export declare class MoviesAPI {
      * @returns A promise that resolves to the movie alternative titles.
      * @reference https://developer.themoviedb.org/reference/movie-alternative-titles
      */
-    alternative_titles(movie_id: number, country?: string): Promise<MovieAlternativeTitles>;
+    alternative_titles(params: MovieAlternativeTitlesParams): Promise<MovieAlternativeTitles>;
     /**
      * Credits
      * GET - https://api.themoviedb.org/3/movie/{movie_id}/credits

package/dist/endpoints/movies.js

@@ -1,3 +1,4 @@
+import { mergeParams } from "../utils/params";
 export const MOVIE_ENDPOINTS = {
     MOVIE: "/movie",
     ALTERNATIVE_TITLES: "/alternative_titles",
@@ -22,8 +23,10 @@ export const MOVIE_ENDPOINTS = {
 };
 export class MoviesAPI {
     client;
-    constructor(client) {
+    defaultOptions;
+    constructor(client, options = {}) {
         this.client = client;
+        this.defaultOptions = options;
     }
     /**
      * Details
@@ -36,10 +39,10 @@ export class MoviesAPI {
      * @returns A promise that resolves to the movie details.
      * @reference https://developer.themoviedb.org/reference/movie-details
      */
-    async details(movie_id, append_to_response, language) {
-        const params = { append_to_response, language };
-        const endpoint = `${MOVIE_ENDPOINTS.MOVIE}/${movie_id}`;
-        return this.client.request(endpoint, params);
+    async details(params) {
+        const mergedParams = { ...this.defaultOptions, ...params };
+        const endpoint = `${MOVIE_ENDPOINTS.MOVIE}/${mergedParams.movie_id}`;
+        return this.client.request(endpoint, mergedParams);
     }
     /**
      * Alternative Titles
@@ -51,10 +54,10 @@ export class MoviesAPI {
      * @returns A promise that resolves to the movie alternative titles.
      * @reference https://developer.themoviedb.org/reference/movie-alternative-titles
      */
-    async alternative_titles(movie_id, country) {
-        const params = { country: country || "" };
-        const endpoint = `${MOVIE_ENDPOINTS.MOVIE}/${movie_id}${MOVIE_ENDPOINTS.ALTERNATIVE_TITLES}`;
-        return this.client.request(endpoint, params);
+    async alternative_titles(params) {
+        const mergedParams = mergeParams(this.defaultOptions, params);
+        const endpoint = `${MOVIE_ENDPOINTS.MOVIE}/${mergedParams.movie_id}${MOVIE_ENDPOINTS.ALTERNATIVE_TITLES}`;
+        return this.client.request(endpoint, mergedParams);
     }
     /**
      * Credits

package/dist/endpoints/search.d.ts

@@ -1,12 +1,14 @@
 import { ApiClient } from "../client";
 import { MovieResultItem } from "../types/movies";
 import { PaginatedResponse, SearchMoviesParams } from "../types/params";
+import { TMDBOptions } from "../tmdb";
 export declare const SEARCH_ENDPOINTS: {
     MOVIE: string;
 };
 export declare class SearchAPI {
     private client;
-    constructor(client: ApiClient);
+    private defaultOptions;
+    constructor(client: ApiClient, defaultOptions?: TMDBOptions);
     /**
      * Search
      * GET - https://api.themoviedb.org/3/search/movie

package/dist/endpoints/search.js

@@ -3,8 +3,10 @@ export const SEARCH_ENDPOINTS = {
 };
 export class SearchAPI {
     client;
-    constructor(client) {
+    defaultOptions; // ** Default options for all requests
+    constructor(client, defaultOptions = {}) {
         this.client = client;
+        this.defaultOptions = defaultOptions;
     }
     /**
      * Search
@@ -22,6 +24,8 @@ export class SearchAPI {
      */
     async movies(params) {
         const endpoint = `${SEARCH_ENDPOINTS.MOVIE}`;
-        return this.client.request(endpoint, params);
+        // Merge defaultOptions with params, giving precedence to params
+        const mergedParams = { ...this.defaultOptions, ...params };
+        return this.client.request(endpoint, mergedParams);
     }
 }

package/dist/index.d.ts

@@ -2,3 +2,8 @@ export { TMDB } from "./tmdb";
 export { TMDBError } from "./errors/tmdb";
 export type { MovieDetails, MovieAlternativeTitle, MovieAlternativeTitles, MovieCredits, MovieExternalIDs, MovieImages, MovieKeywords, MovieReleaseDates, MovieTranslations, MovieVideos, } from "./types/movies";
 export type { Changes, Collection, Genre, ImageItem, Keyword, ProductionCompany, ProductionCountry, SpokenLanguage, VideoItem, Cast, Crew, } from "./types/common";
+export type { SearchMoviesParams, MovieDetailsParams, MovieListParams, PaginatedResponse, MovieAlternativeTitlesParams, } from "./types/params";
+export type { CountryISO3166_1 } from "./types/countries";
+export { TMDBCountries } from "./types/countries";
+export type { LanguageISO6391 } from "./types/lang";
+export { Languages } from "./types/lang";

package/dist/index.js

@@ -1,3 +1,5 @@
 // src/index.ts
 export { TMDB } from "./tmdb";
 export { TMDBError } from "./errors/tmdb";
+export { TMDBCountries } from "./types/countries";
+export { Languages } from "./types/lang";

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

@@ -3,7 +3,7 @@ import { TMDB } from "../../tmdb";
 const token = process.env.TMDB_ACCESS_TOKEN;
 if (!token)
     throw new Error("TMDB_ACCESS_TOKEN is not set, plaase set it in your enviroment variables.");
-const tmdb = new TMDB(token);
+const tmdb = new TMDB(token, { language: "it-IT", region: "IT", country: "IT" });
 describe("Movie List (integration)", () => {
     it("(NOW PLAYING) should get now playing movies", async () => {
         const now_playing = await tmdb.movie_lists.now_playing();

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

@@ -9,7 +9,7 @@ const tmdb = new TMDB(token);
 describe("Movies (integration)", () => {
     it("(MOVIE DETAILS) should get movie details", async () => {
         const movie_id = 550; // Fight Club
-        const movie = await tmdb.movies.details(movie_id);
+        const movie = await tmdb.movies.details({ movie_id });
         expect(movie).toBeDefined();
         expect(movie.id).toBe(movie_id);
         expect(movie.title).toBe("Fight Club");
@@ -18,7 +18,7 @@ describe("Movies (integration)", () => {
         const invalid_movie_id = -1; // Invalid movie ID
         // ** Can't test the specific error because API is not returning the same error for the same request
         try {
-            await tmdb.movies.details(invalid_movie_id);
+            await tmdb.movies.details({ movie_id: invalid_movie_id });
             throw new Error("Expected TMDBError was not thrown");
         }
         catch (error) {
@@ -27,7 +27,7 @@ describe("Movies (integration)", () => {
     });
     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);
+        const movie_titles = await tmdb.movies.alternative_titles({ movie_id });
         expect(movie_titles).toBeDefined();
         expect(movie_titles.id).toBe(movie_id);
         expect(movie_titles.titles.length).toBeGreaterThan(0);

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

@@ -14,19 +14,21 @@ 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-US";
-        await moviesAPI.details(movie_id, append_to_response, language);
+        const language = "en";
+        await moviesAPI.details({ movie_id, append_to_response, language });
         expect(clientMock.request).toHaveBeenCalledOnce();
         expect(clientMock.request).toHaveBeenCalledWith("/movie/550", {
+            movie_id,
             append_to_response,
             language,
         });
     });
     it("should work correctly without optional parameters", async () => {
         const movie_id = 550;
-        await moviesAPI.details(movie_id);
+        await moviesAPI.details({ movie_id });
         expect(clientMock.request).toHaveBeenCalledOnce();
         expect(clientMock.request).toHaveBeenCalledWith("/movie/550", {
+            movie_id,
             append_to_response: undefined,
             language: undefined,
         });
@@ -34,7 +36,7 @@ describe("MoviesAPI", () => {
     it("should return the result from client.request", async () => {
         const fakeResponse = { id: 550, title: "Fight Club" };
         clientMock.request.mockResolvedValue(fakeResponse);
-        const result = await moviesAPI.details(550);
+        const result = await moviesAPI.details({ movie_id: 550 });
         expect(result).toEqual(fakeResponse);
     });
 });

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

@@ -12,4 +12,12 @@ describe("Search (integration)", () => {
         expect(movies.results.length).toBeGreaterThan(0);
         expect(movies.results[0].title).toBe("Fight Club");
     });
+    it("(SEARCH MOVIE) should search for a movie with default options", async () => {
+        const tmdb = new TMDB(token, { language: "it-IT", region: "IT" });
+        const movies = await tmdb.search.movies({ query: "Fight Club" });
+        expect(movies.page).toBe(1);
+        expect(movies.total_results).toBeGreaterThan(0);
+        expect(movies.results.length).toBeGreaterThan(0);
+        expect(movies.results[0].title).toBe("Fight Club");
+    });
 });

package/dist/tmdb.d.ts

@@ -1,10 +1,26 @@
 import { MovieListsAPI } from "./endpoints/movie_lists";
 import { MoviesAPI } from "./endpoints/movies";
 import { SearchAPI } from "./endpoints/search";
+export type TMDBOptions = {
+    language?: string;
+    region?: string;
+    country?: string;
+};
 export declare class TMDB {
     private client;
+    private options;
     movies: MoviesAPI;
     movie_lists: MovieListsAPI;
     search: SearchAPI;
-    constructor(accessToken: string);
+    /**
+     * Creates a new TMDB instance.
+     * @param accessToken The TMDB API access token.
+     * @param options Optional default options (e.g., language) for all requests.
+     */
+    constructor(accessToken: string, options?: TMDBOptions);
+    /**
+     * Helper to merge default options with method-specific params.
+     * Method-level params override defaults.
+     */
+    withDefaults<T extends object>(params?: T): T & TMDBOptions;
 }

package/dist/tmdb.js

@@ -6,16 +6,30 @@ import { SearchAPI } from "./endpoints/search";
 import { Errors } from "./errors/messages";
 export class TMDB {
     client;
+    options; // ** Default options for all requests
     movies;
     movie_lists;
     search;
     // etc...
-    constructor(accessToken) {
+    /**
+     * Creates a new TMDB instance.
+     * @param accessToken The TMDB API access token.
+     * @param options Optional default options (e.g., language) for all requests.
+     */
+    constructor(accessToken, options = {}) {
         if (!accessToken)
             throw new Error(Errors.NO_ACCESS_TOKEN);
+        this.options = options;
         this.client = new ApiClient(accessToken);
-        this.movies = new MoviesAPI(this.client);
-        this.movie_lists = new MovieListsAPI(this.client);
-        this.search = new SearchAPI(this.client);
+        this.movies = new MoviesAPI(this.client, options);
+        this.movie_lists = new MovieListsAPI(this.client, options);
+        this.search = new SearchAPI(this.client, options);
+    }
+    /**
+     * Helper to merge default options with method-specific params.
+     * Method-level params override defaults.
+     */
+    withDefaults(params) {
+        return { ...this.options, ...params };
     }
 }

package/dist/types/countries.d.ts

@@ -0,0 +1,6 @@
+export declare const TMDBCountries: {
+    iso_3166_1: CountryISO3166_1;
+    english_name: string;
+    native_name: string;
+}[];
+export type CountryISO3166_1 = "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AN" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BM" | "BN" | "BO" | "BR" | "BS" | "BT" | "BU" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CS" | "CU" | "CV" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SU" | "SV" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TP" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XC" | "XG" | "XI" | "XK" | "YE" | "YT" | "YU" | "ZA" | "ZM" | "ZR" | "ZW";