@lorenzopant/tmdb 1.17.0 → 1.17.2

package/dist/endpoints/configuration.js

@@ -1,83 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class ConfigurationAPI extends TMDBAPIBase {
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/configuration
-     *
-     * Query the API configuration details.
-     * The data returned here in the configuration endpoint is designed to provide some of
-     * the required information you'll need as you integrate our API.
-     * For example, you can get a list of valid image sizes and the valid image address.
-     * @reference https://developer.themoviedb.org/reference/configuration-details
-     */
-    async details() {
-        return this.client.request(ENDPOINTS.CONFIGURATION.DETAILS);
-    }
-    /**
-     * Countries
-     * GET -  https://api.themoviedb.org/3/configuration/countries
-     *
-     * Get the list of countries (ISO 3166-1 tags) used throughout TMDB.
-     * @param language Language (Defaults to en-US)
-     * @reference https://developer.themoviedb.org/reference/configuration-countries
-     */
-    async countries(params) {
-        return this.client.request(ENDPOINTS.CONFIGURATION.COUNTRIES, this.withLanguage(params));
-    }
-    /**
-     * Jobs
-     * GET -  https://api.themoviedb.org/3/configuration/jobs
-     *
-     * Get the list of the jobs and departments used throughout TMDB.
-     * @reference https://developer.themoviedb.org/reference/configuration-jobs
-     */
-    async jobs() {
-        return this.client.request(ENDPOINTS.CONFIGURATION.JOBS);
-    }
-    /**
-     * Languages
-     * GET -  https://api.themoviedb.org/3/configuration/languages
-     *
-     * Get the list of the languages (ISO 639-1 tags) used throughout TMDB.
-     * @reference https://developer.themoviedb.org/reference/configuration-languages
-     */
-    async languages() {
-        return this.client.request(ENDPOINTS.CONFIGURATION.LANGUAGES);
-    }
-    /**
-     * Primary Translations
-     * GET -  https://api.themoviedb.org/3/configuration/primary_translations
-     *
-     * Get a list of the officially supported translations on TMDB.
-     *
-     * While it's technically possible to add a translation in any one of the languages we have added to TMDB
-     * (we don't restrict content), the ones listed in this method are the ones
-     * we also support for localizing the website with which means they are "primary" translations.
-     *
-     * These are all specified as IETF tags to identify the languages we use on TMDB. There is one exception which is image languages.
-     * They are currently only designated by a ISO-639-1 tag.
-     * This is a planned upgrade for the future.
-     *
-     * We're always open to adding more if you think one should be added.
-     * You can ask about getting a new primary translation added by posting on the forums.
-     *
-     * One more thing to mention, these are the translations that map to our website translation project.
-     * You can view and contribute to that project here.
-     *
-     * @reference https://developer.themoviedb.org/reference/configuration-primary-translations
-     */
-    async primary_translations() {
-        return this.client.request(ENDPOINTS.CONFIGURATION.PRIMARY_TRANSLATIONS);
-    }
-    /**
-     * Timezones
-     * GET -  https://api.themoviedb.org/3/configuration/timezones
-     *
-     * Get the list of timezones used throughout TMDB.
-     * @reference https://developer.themoviedb.org/reference/configuration-timezones
-     */
-    async timezones() {
-        return this.client.request(ENDPOINTS.CONFIGURATION.TIMEZONES);
-    }
-}

package/dist/endpoints/credits.d.ts

@@ -1,16 +0,0 @@
-import { CreditDetails, CreditDetailsParams } from "../types/credits";
-import { TMDBAPIBase } from "./base";
-export declare class CreditsAPI extends TMDBAPIBase {
-    private creditPath;
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/credit/{credit_id}
-     *
-     * Get the detailed information for a movie or TV credit.
-     *
-     * @param credit_id Unique identifier for the credit
-     * @param language Language for the response
-     * @reference https://developer.themoviedb.org/reference/credit-details
-     */
-    details(params: CreditDetailsParams): Promise<CreditDetails>;
-}

package/dist/endpoints/credits.js

@@ -1,22 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class CreditsAPI extends TMDBAPIBase {
-    creditPath(credit_id) {
-        return `${ENDPOINTS.CREDITS.DETAILS}/${credit_id}`;
-    }
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/credit/{credit_id}
-     *
-     * Get the detailed information for a movie or TV credit.
-     *
-     * @param credit_id Unique identifier for the credit
-     * @param language Language for the response
-     * @reference https://developer.themoviedb.org/reference/credit-details
-     */
-    async details(params) {
-        const endpoint = this.creditPath(params.credit_id);
-        const requestParams = this.withLanguage(params) ?? params;
-        return this.client.request(endpoint, requestParams);
-    }
-}

package/dist/endpoints/discover.d.ts

@@ -1,36 +0,0 @@
-import { DiscoverMovieParams, DiscoverTVParams, DiscoverTVResultItem, MovieResultItem, PaginatedResponse } from "../types";
-import { TMDBAPIBase } from "./base";
-export declare class DiscoverAPI extends TMDBAPIBase {
-    /**
-     * TMDB discover filtering notes:
-     *
-     * - If `region` is provided on movie discover, TMDB uses the regional release date
-     *   instead of the primary release date. When `with_release_type` is also provided,
-     *   the returned release date follows the order of the specified release types.
-     * - Filters that accept comma-separated or pipe-separated values are forwarded as-is:
-     *   commas mean AND, pipes mean OR.
-     *
-     * @reference https://developer.themoviedb.org/reference/discover-movie
-     * @reference https://developer.themoviedb.org/reference/discover-tv
-     */
-    private withMovieDefaults;
-    private withTVDefaults;
-    /**
-     * Movie
-     * GET - https://api.themoviedb.org/3/discover/movie
-     *
-     * Discover movies by applying filters and sort options.
-     *
-     * @reference https://developer.themoviedb.org/reference/discover-movie
-     */
-    movie(params?: DiscoverMovieParams): Promise<PaginatedResponse<MovieResultItem>>;
-    /**
-     * TV
-     * GET - https://api.themoviedb.org/3/discover/tv
-     *
-     * Discover TV series by applying filters and sort options.
-     *
-     * @reference https://developer.themoviedb.org/reference/discover-tv
-     */
-    tv(params?: DiscoverTVParams): Promise<PaginatedResponse<DiscoverTVResultItem>>;
-}

package/dist/endpoints/discover.js

@@ -1,61 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class DiscoverAPI extends TMDBAPIBase {
-    /**
-     * TMDB discover filtering notes:
-     *
-     * - If `region` is provided on movie discover, TMDB uses the regional release date
-     *   instead of the primary release date. When `with_release_type` is also provided,
-     *   the returned release date follows the order of the specified release types.
-     * - Filters that accept comma-separated or pipe-separated values are forwarded as-is:
-     *   commas mean AND, pipes mean OR.
-     *
-     * @reference https://developer.themoviedb.org/reference/discover-movie
-     * @reference https://developer.themoviedb.org/reference/discover-tv
-     */
-    withMovieDefaults(params) {
-        if (!params && !this.defaultOptions.language && !this.defaultOptions.region)
-            return undefined;
-        const language = params?.language ?? this.defaultOptions.language;
-        const region = params?.region ?? this.defaultOptions.region;
-        return {
-            ...params,
-            language,
-            region,
-        };
-    }
-    withTVDefaults(params) {
-        if (!params && !this.defaultOptions.language && !this.defaultOptions.timezone) {
-            return undefined;
-        }
-        const language = params?.language ?? this.defaultOptions.language;
-        const timezone = params?.timezone ?? this.defaultOptions.timezone;
-        return {
-            ...params,
-            language,
-            timezone,
-        };
-    }
-    /**
-     * Movie
-     * GET - https://api.themoviedb.org/3/discover/movie
-     *
-     * Discover movies by applying filters and sort options.
-     *
-     * @reference https://developer.themoviedb.org/reference/discover-movie
-     */
-    async movie(params = {}) {
-        return this.client.request(ENDPOINTS.DISCOVER.MOVIE, this.withMovieDefaults(params));
-    }
-    /**
-     * TV
-     * GET - https://api.themoviedb.org/3/discover/tv
-     *
-     * Discover TV series by applying filters and sort options.
-     *
-     * @reference https://developer.themoviedb.org/reference/discover-tv
-     */
-    async tv(params = {}) {
-        return this.client.request(ENDPOINTS.DISCOVER.TV, this.withTVDefaults(params));
-    }
-}

package/dist/endpoints/find.d.ts

@@ -1,16 +0,0 @@
-import { FindByIDParams, FindResults } from "../types";
-import { TMDBAPIBase } from "./base";
-export declare class FindAPI extends TMDBAPIBase {
-    /**
-     * By ID
-     * GET - https://api.themoviedb.org/3/find/{external_id}
-     *
-     * Find movies, TV series, seasons, episodes, or people by an external ID.
-     *
-     * @param external_id External identifier to look up
-     * @param external_source Source namespace for the external ID
-     * @param language Language for localized results
-     * @reference https://developer.themoviedb.org/reference/find-by-id
-     */
-    by_id(params: FindByIDParams): Promise<FindResults>;
-}

package/dist/endpoints/find.js

@@ -1,21 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class FindAPI extends TMDBAPIBase {
-    /**
-     * By ID
-     * GET - https://api.themoviedb.org/3/find/{external_id}
-     *
-     * Find movies, TV series, seasons, episodes, or people by an external ID.
-     *
-     * @param external_id External identifier to look up
-     * @param external_source Source namespace for the external ID
-     * @param language Language for localized results
-     * @reference https://developer.themoviedb.org/reference/find-by-id
-     */
-    async by_id(params) {
-        const { external_id, ...rest } = params;
-        const endpoint = `${ENDPOINTS.FIND}/${encodeURIComponent(external_id)}`;
-        const requestParams = this.withLanguage(rest);
-        return this.client.request(endpoint, requestParams);
-    }
-}

package/dist/endpoints/genres.d.ts

@@ -1,25 +0,0 @@
-import { WithLanguage } from "../types";
-import { GenresResponse } from "../types/common/media";
-import { TMDBAPIBase } from "./base";
-export declare class GenresAPI extends TMDBAPIBase {
-    /**
-     * Movie List
-     * GET - https://api.themoviedb.org/3/genre/movie/list
-     *
-     * Get the list of official genres for movies.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the genres list.
-     * @reference https://developer.themoviedb.org/reference/genre-movie-list
-     */
-    movie_list(params?: WithLanguage): Promise<GenresResponse>;
-    /**
-     * TV List
-     * GET - https://api.themoviedb.org/3/genre/tv/list
-     *
-     * Get the list of official genres for TV shows.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the genres list.
-     * @reference https://developer.themoviedb.org/reference/genre-tv-list
-     */
-    tv_list(params?: WithLanguage): Promise<GenresResponse>;
-}

package/dist/endpoints/genres.js

@@ -1,28 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class GenresAPI extends TMDBAPIBase {
-    /**
-     * Movie List
-     * GET - https://api.themoviedb.org/3/genre/movie/list
-     *
-     * Get the list of official genres for movies.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the genres list.
-     * @reference https://developer.themoviedb.org/reference/genre-movie-list
-     */
-    async movie_list(params) {
-        return this.client.request(ENDPOINTS.GENRES.MOVIE_LIST, this.withLanguage(params));
-    }
-    /**
-     * TV List
-     * GET - https://api.themoviedb.org/3/genre/tv/list
-     *
-     * Get the list of official genres for TV shows.
-     * @param language The language to use for the response.
-     * @returns A promise that resolves to the genres list.
-     * @reference https://developer.themoviedb.org/reference/genre-tv-list
-     */
-    async tv_list(params) {
-        return this.client.request(ENDPOINTS.GENRES.TV_LIST, this.withLanguage(params));
-    }
-}

package/dist/endpoints/keywords.d.ts

@@ -1,29 +0,0 @@
-import { Keyword, KeywordDetailsParams, KeywordMoviesParams, MovieResultItem, PaginatedResponse } from "../types";
-import { TMDBAPIBase } from "./base";
-export declare class KeywordsAPI extends TMDBAPIBase {
-    private keywordPath;
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/keyword/{keyword_id}
-     *
-     * Get the details of a keyword by ID.
-     *
-     * @param keyword_id Unique identifier for the keyword
-     * @reference https://developer.themoviedb.org/reference/keyword-details
-     */
-    details(params: KeywordDetailsParams): Promise<Keyword>;
-    /**
-     * Movies
-     * GET - https://api.themoviedb.org/3/keyword/{keyword_id}/movies
-     *
-     * Get the movies associated with a keyword.
-     *
-     * @deprecated TMDB marks this endpoint as deprecated. Use discover/movie with_keywords instead.
-     * @param keyword_id Unique identifier for the keyword
-     * @param language Language for localized results
-     * @param page Page number for paginated results
-     * @param include_adult Include adult titles in results
-     * @reference https://developer.themoviedb.org/reference/keyword-movies
-     */
-    movies(params: KeywordMoviesParams): Promise<PaginatedResponse<MovieResultItem>>;
-}

package/dist/endpoints/keywords.js

@@ -1,38 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class KeywordsAPI extends TMDBAPIBase {
-    keywordPath(keyword_id) {
-        return `${ENDPOINTS.KEYWORDS.DETAILS}/${keyword_id}`;
-    }
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/keyword/{keyword_id}
-     *
-     * Get the details of a keyword by ID.
-     *
-     * @param keyword_id Unique identifier for the keyword
-     * @reference https://developer.themoviedb.org/reference/keyword-details
-     */
-    async details(params) {
-        const endpoint = this.keywordPath(params.keyword_id);
-        return this.client.request(endpoint, params);
-    }
-    /**
-     * Movies
-     * GET - https://api.themoviedb.org/3/keyword/{keyword_id}/movies
-     *
-     * Get the movies associated with a keyword.
-     *
-     * @deprecated TMDB marks this endpoint as deprecated. Use discover/movie with_keywords instead.
-     * @param keyword_id Unique identifier for the keyword
-     * @param language Language for localized results
-     * @param page Page number for paginated results
-     * @param include_adult Include adult titles in results
-     * @reference https://developer.themoviedb.org/reference/keyword-movies
-     */
-    async movies(params) {
-        const endpoint = `${this.keywordPath(params.keyword_id)}${ENDPOINTS.KEYWORDS.MOVIES}`;
-        const requestParams = this.withLanguage(params);
-        return this.client.request(endpoint, requestParams);
-    }
-}

package/dist/endpoints/movie_lists.d.ts

@@ -1,53 +0,0 @@
-import { MovieResultItem, PaginatedResponse } from "../types";
-import { MovieListParams } from "../types/movies";
-import { TMDBAPIBase } from "./base";
-export declare class MovieListsAPI extends TMDBAPIBase {
-    private withDefaults;
-    /**
-     * Fetch Movie List Wrapper
-     * @param endpoint Endpoint to call
-     * @param params Params for the request (language, page, region, etc)
-     * @returns Specific to endpoint (MovieListResult)
-     */
-    private fetch_movie_list;
-    /**
-     * 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 or TMDB default)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
-     */
-    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 or TMDB default)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
-     */
-    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 or TMDB default)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
-     */
-    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 or TMDB default)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
-     */
-    upcoming(params?: MovieListParams): Promise<PaginatedResponse<MovieResultItem>>;
-}

package/dist/endpoints/movie_lists.js

@@ -1,65 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class MovieListsAPI extends TMDBAPIBase {
-    withDefaults(params) {
-        const { language = this.defaultOptions.language, region = this.defaultOptions.region, ...rest } = params;
-        return { language, region, ...rest };
-    }
-    /**
-     * Fetch Movie List Wrapper
-     * @param endpoint Endpoint to call
-     * @param params Params for the request (language, page, region, etc)
-     * @returns Specific to endpoint (MovieListResult)
-     */
-    fetch_movie_list(endpoint, params = {}) {
-        return this.client.request(ENDPOINTS.MOVIES.DETAILS + endpoint, this.withDefaults(params));
-    }
-    /**
-     * 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 or TMDB default)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
-     */
-    async now_playing(params = {}) {
-        return this.fetch_movie_list(ENDPOINTS.MOVIES.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 or TMDB default)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
-     */
-    async popular(params = {}) {
-        return this.fetch_movie_list(ENDPOINTS.MOVIES.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 or TMDB default)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
-     */
-    async top_rated(params = {}) {
-        return this.fetch_movie_list(ENDPOINTS.MOVIES.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 or TMDB default)
-     * @param page Page (Defaults to 1)
-     * @param region ISO-3166-1 code
-     */
-    async upcoming(params = {}) {
-        return this.fetch_movie_list(ENDPOINTS.MOVIES.UPCOMING, params);
-    }
-}