@lorenzopant/tmdb 1.17.1 → 1.17.2

package/dist/tmdb.js

@@ -1,94 +0,0 @@
-// src.tmdb.ts
-import { ApiClient } from "./client";
-import { CertificationsAPI } from "./endpoints/certifications";
-import { ChangesAPI } from "./endpoints/changes";
-import { CompaniesAPI } from "./endpoints/companies";
-import { CreditsAPI } from "./endpoints/credits";
-import { CollectionsAPI } from "./endpoints/collections";
-import { ConfigurationAPI } from "./endpoints/configuration";
-import { DiscoverAPI } from "./endpoints/discover";
-import { FindAPI } from "./endpoints/find";
-import { GenresAPI } from "./endpoints/genres";
-import { KeywordsAPI } from "./endpoints/keywords";
-import { MovieListsAPI } from "./endpoints/movie_lists";
-import { MoviesAPI } from "./endpoints/movies";
-import { SearchAPI } from "./endpoints/search";
-import { TVSeriesAPI } from "./endpoints/tv_series";
-import { TVSeriesListsAPI } from "./endpoints/tv_series_lists";
-import { WatchProvidersAPI } from "./endpoints/watch_providers";
-import { Errors } from "./errors/messages";
-import { ImageAPI } from "./images/images";
-import { NetworksAPI } from "./endpoints/networks";
-import { TVEpisodesAPI } from "./endpoints/tv_episodes";
-import { TVEpisodeGroupsAPI } from "./endpoints/tv_episode_groups";
-import { TVSeasonsAPI } from "./endpoints/tv_seasons";
-import { TrendingAPI } from "./endpoints/trending";
-import { ReviewsAPI } from "./endpoints/reviews";
-import { PeopleListsAPI } from "./endpoints/people_lists";
-import { PeopleAPI } from "./endpoints/people";
-export class TMDB {
-    client;
-    options; // ** Default options for all requests
-    movies;
-    movie_lists;
-    search;
-    images;
-    configuration;
-    genres;
-    keywords;
-    tv_lists;
-    tv_series;
-    watch_providers;
-    certifications;
-    changes;
-    companies;
-    credits;
-    collections;
-    discover;
-    find;
-    networks;
-    tv_episodes;
-    tv_episode_groups;
-    tv_seasons;
-    trending;
-    reviews;
-    people_lists;
-    people;
-    // etc...
-    /**
-     * 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, { logger: options.logger, deduplication: options.deduplication });
-        this.movies = new MoviesAPI(this.client, this.options);
-        this.movie_lists = new MovieListsAPI(this.client, this.options);
-        this.search = new SearchAPI(this.client, this.options);
-        this.images = new ImageAPI(this.options.images);
-        this.configuration = new ConfigurationAPI(this.client, this.options);
-        this.genres = new GenresAPI(this.client, this.options);
-        this.keywords = new KeywordsAPI(this.client, this.options);
-        this.tv_lists = new TVSeriesListsAPI(this.client, this.options);
-        this.tv_series = new TVSeriesAPI(this.client, this.options);
-        this.watch_providers = new WatchProvidersAPI(this.client, this.options);
-        this.certifications = new CertificationsAPI(this.client, this.options);
-        this.changes = new ChangesAPI(this.client, this.options);
-        this.companies = new CompaniesAPI(this.client, this.options);
-        this.credits = new CreditsAPI(this.client, this.options);
-        this.collections = new CollectionsAPI(this.client, this.options);
-        this.discover = new DiscoverAPI(this.client, this.options);
-        this.find = new FindAPI(this.client, this.options);
-        this.networks = new NetworksAPI(this.client, this.options);
-        this.tv_episodes = new TVEpisodesAPI(this.client, this.options);
-        this.tv_episode_groups = new TVEpisodeGroupsAPI(this.client, this.options);
-        this.tv_seasons = new TVSeasonsAPI(this.client, this.options);
-        this.trending = new TrendingAPI(this.client, this.options);
-        this.reviews = new ReviewsAPI(this.client, this.options);
-        this.people_lists = new PeopleListsAPI(this.client, this.options);
-        this.people = new PeopleAPI(this.client, this.options);
-    }
-}

package/dist/types/collections.d.ts

@@ -1,72 +0,0 @@
-import { MediaType, TranslationResults, WithLanguage } from "./common";
-import { ImageItem, ImagesResult } from "./common/images";
-import { Language, LanguageISO6391 } from "./config";
-import { MovieResultItem } from "./search";
-/**
- * Represents a TMDB collection (e.g. a movie franchise or saga),
- * including metadata and the list of media items that belong to it.
- */
-export type Collection = {
-    /** Unique TMDB identifier for the collection */
-    id: number;
-    /** Display name of the collection */
-    name: string;
-    /** Original language code of the collection (e.g. `"en"`, `"it"`) */
-    original_language: string;
-    /** Name of the collection in its original language */
-    original_name: string;
-    /** Short description or synopsis of the collection */
-    overview: string;
-    /** Relative path to the collection's poster image on TMDB, if available (sanitized nulls become undefined) */
-    poster_path?: string | null;
-    /** Relative path to the collection's backdrop image on TMDB, if available (sanitized nulls become undefined) */
-    backdrop_path?: string | null;
-    /** Ordered list of media items that make up the collection */
-    parts: CollectionItem[];
-};
-/**
- * Represents a single media item within a collection.
- * Extends {@link MovieResultItem} by replacing `title` and `original_title`
- * with their localization-agnostic equivalents, and adding a `media_type` discriminator.
- * Hopefully both tv and movies use name and original name instead of title.
- */
-export type CollectionItem = Omit<MovieResultItem, "title" | "original_title"> & {
-    /** The type of media (e.g. `"movie"` or `"tv"`), used as a discriminator */
-    media_type: MediaType;
-    /** Display name of the media item */
-    name: string;
-    /** Name of the media item in its original language */
-    original_name: string;
-};
-/**
- * Represents the images associated with a TMDB collection,
- * including backdrops and posters.
- */
-export type CollectionImages = ImagesResult<ImageItem, "backdrops" | "posters">;
-/**
- * Represents the available translations for a TMDB collection.
- */
-export type CollectionTranslations = TranslationResults<CollectionTranslationData>;
-/**
- * Contains the localized fields provided by a collection translation.
- * All fields are optional as not every translation may supply all values.
- */
-export type CollectionTranslationData = {
-    /** Localized title of the collection */
-    title?: string;
-    /** Localized overview or synopsis of the collection */
-    overview?: string;
-    /** Localized homepage URL for the collection */
-    homepage?: string;
-};
-/** Base param used by all collection queries */
-export type CollectionBaseParam = {
-    /** Uniquely identifies a collection in TMDB. */
-    collection_id: number;
-};
-export type CollectionDetailsParams = CollectionBaseParam & WithLanguage;
-export type CollectionImagesParams = CollectionBaseParam & {
-    language?: Language | LanguageISO6391;
-    /** Languages to include images for. Pass an array — it will be serialized as a comma-separated list (e.g. ["en", "null"]). Use "null" to include untagged images. */
-    include_image_language?: (Language | "null")[];
-};

package/dist/types/collections.js

@@ -1 +0,0 @@
-export {};

package/dist/types/common/certifications.d.ts

@@ -1,19 +0,0 @@
-import { CountryISO3166_1 } from "../config";
-/**
- * Represents a content rating certification for a movie or TV show.
- */
-export type CertificationItem = {
-    /** The certification label as defined by the rating authority (e.g. `PG-13`, `18+`, `R`) */
-    certification: string;
-    /** A human-readable description of the audience this certification targets or restricts */
-    meaning?: string;
-    /** The display order of this certification relative to others in the same rating system */
-    order?: number;
-};
-/**
- * A map of content rating certifications grouped by country.
- */
-export type Certifications = {
-    /** A record mapping each country (ISO 3166-1 alpha-2 code) to its list of applicable certifications */
-    certifications: Record<CountryISO3166_1, CertificationItem[]>;
-};

package/dist/types/common/certifications.js

@@ -1 +0,0 @@
-export {};

package/dist/types/common/changes.d.ts

@@ -1,44 +0,0 @@
-/**
- * Container for entity change history
- */
-export type Changes = {
-    /** Array of changes grouped by type */
-    changes: Change[];
-};
-/**
- * Group of changes for a specific field or property
- */
-export type Change = {
-    /** Name of the field that changed (e.g., "title", "overview", "images") */
-    key: string;
-    /** Individual change entries for this field */
-    items: ChangeItem[];
-};
-/**
- * Individual change record with action details
- */
-export type ChangeItem = {
-    /** Unique identifier for the changed item */
-    id: number | string;
-    /** Type of change performed (e.g., "added", "updated", "deleted") */
-    action: string;
-    /** Timestamp of when the change occurred (ISO 8601 format) */
-    time: string;
-    /** ISO 639-1 language code associated with the change */
-    iso_639_1?: string | null;
-    /** ISO 3166-1 country code associated with the change */
-    iso_3166_1?: string | null;
-    /** The changed data object (structure varies by change type) */
-    value: object | string;
-    /** The original data object (structure varies by change type) */
-    original_value?: object | string;
-};
-/**
- * Represents a single change result item from the changes endpoint.
- */
-export type ChangeResultItem = {
-    /** Id of the movie, tv show or person */
-    id: number;
-    /** Whether the movie, tv show or person is marked as adult content */
-    adult: boolean;
-};

package/dist/types/common/changes.js

@@ -1 +0,0 @@
-export {};

package/dist/types/common/images.d.ts

@@ -1,64 +0,0 @@
-import { LiteralUnion } from "../utility";
-/**
- * Defines the possible image collection keys returned by TMDB image endpoints.
- */
-export type ImageCollectionKey = "backdrops" | "logos" | "posters" | "profiles" | "stills";
-/**
- * Image metadata and details
- */
-export type ImageItem = {
-    /** Aspect ratio of the image (width/height) */
-    aspect_ratio: number;
-    /** Image height in pixels */
-    height: number;
-    /** ISO 639-1 language code if image contains text, null otherwise */
-    iso_639_1?: string | null;
-    /** Relative path to the image file (append to base URL) */
-    file_path: string;
-    /** Average user rating for this image */
-    vote_average: number;
-    /** Total number of votes for this image */
-    vote_count: number;
-    /** Image width in pixels */
-    width: number;
-};
-/**
- * Represents a single company or network logo (slightly different from ImageItem)
- *
- * Note on FileType from TMDB:
- * There are two image formats that are supported for companies, PNG's and SVG's.
- * You can see which type the original file is by looking at the file_type field.
- * We prefer SVG's as they are resolution independent and as such, the width and height are only
- * there to reflect the original asset that was uploaded.
- * An SVG can be scaled properly beyond those dimensions if you call them as a PNG.
- */
-export type OrganizationImage = Omit<ImageItem, "iso_639_1"> & {
-    id: string;
-    file_type: FileType;
-};
-/**
- * Represents the response from a TMDB image endpoint.
- * Use the generic parameter to specify which image collections are present.
- *
- * @template K - The image collection keys available for the given entity type.
- *
- * @example
- * // Company or Network (logos only)
- * type OrganizationImagesResult = ImagesResult<"logos">;
- *
- * @example
- * // Movie or TV Show (backdrops, logos and posters)
- * type MovieImagesResult = ImagesResult<"backdrops" | "logos" | "posters">;
- *
- * @example
- * // Person (profiles only)
- * type PersonImagesResult = ImagesResult<"profiles">;
- */
-export type ImagesResult<T, K extends ImageCollectionKey> = {
-    /** The unique TMDB identifier of the entity. */
-    id: number;
-} & {
-    [P in K]: T[];
-};
-/** Available file type on svg (for images) */
-export type FileType = LiteralUnion<".png" | ".svg">;

package/dist/types/common/images.js

@@ -1 +0,0 @@
-export {};

package/dist/types/common/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./changes";
-export * from "./media";
-export * from "./images";
-export * from "./pagination";
-export * from "./params";
-export * from "./certifications";

package/dist/types/common/index.js

@@ -1,6 +0,0 @@
-export * from "./changes";
-export * from "./media";
-export * from "./images";
-export * from "./pagination";
-export * from "./params";
-export * from "./certifications";

package/dist/types/common/media.d.ts

@@ -1,305 +0,0 @@
-import { CountryISO3166_1 } from "../config/countries";
-/**
- * Represents a genre of a movie or TV show.
- */
-export type Genre = {
-    id: number;
-    name: string;
-};
-/**
- * Response containing available genres
- */
-export type GenresResponse = {
-    /** Array of genre objects with ID and name */
-    genres: Genre[];
-};
-/**
- * Represents a production company involved in creating a movie or TV show.
- */
-export type 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 = {
-    iso_3166_1: string;
-    name: string;
-};
-/**
- * Represents a spoken language in a movie or TV show.
- */
-export type SpokenLanguage = {
-    english_name: string;
-    iso_639_1: string;
-    name: string;
-};
-/**
- * Represents a collection of movies.
- */
-export type MovieCollection = {
-    id: number;
-    name: string;
-    poster_path?: string | null;
-    backdrop_path?: string | null;
-};
-/**
- * Represents common class for cast and crew types
- */
-export type Credit = {
-    adult: boolean;
-    gender: number | null;
-    id: number;
-    known_for_department: string;
-    name: string;
-    original_name: string;
-    popularity: number;
-    profile_path?: string | null;
-    credit_id: string;
-};
-/**
- * Represents a cast member in a movie or TV show.
- */
-export type Cast = Credit & {
-    cast_id: number;
-    character: string;
-    order: number;
-};
-/**
- * Represents a crew member in a movie or TV show.
- */
-export type Crew = Credit & {
-    department: string;
-    job: string;
-};
-/**
- * Represents a keyword entry
- */
-export type Keyword = {
-    id: number;
-    name: string;
-};
-/**
- * Represents an alternative name entry for a company or network.
- *
- * @see https://developer.themoviedb.org/reference/company-alternative-names
- * @see https://developer.themoviedb.org/reference/network-alternative-names
- */
-export type AlternativeName = {
-    /** The alternative name. */
-    name: string;
-    /** The type or context of the alternative name (e.g. "short name", "abbreviation"). */
-    type: string;
-};
-/**
- * Represents the response from the TMDB alternative names endpoint
- * for a company or network.
- *
- * @see https://developer.themoviedb.org/reference/company-alternative-names
- * @see https://developer.themoviedb.org/reference/network-alternative-names
- */
-export type AlternativeNamesResult = {
-    /** The unique TMDB identifier of the company or network. */
-    id: number;
-    /** A list of alternative names associated with the company or network. */
-    results: AlternativeName[];
-};
-/**
- *  Alternative title entry
- */
-export type AlternativeTitle = {
-    /** Alternative title text */
-    title: string;
-    /** ISO 3166-1 country code where this title is used */
-    iso_3166_1: string;
-    /** Type of title (e.g., "original title", "working title") */
-    type: string;
-};
-export type VideoResults = {
-    /** Media identifier */
-    id: number | string;
-    /** Array of video items */
-    results: VideoItem[];
-};
-/**
- * Video metadata and details
- */
-export type VideoItem = {
-    /** ISO 639-1 language code of the video */
-    iso_639_1: string;
-    /** ISO 3166-1 country code where the video is available */
-    iso_3166_1: string;
-    /** Video title or name */
-    name: string;
-    /** Unique video key/ID on the hosting platform */
-    key: string;
-    /** Video hosting platform (e.g., "YouTube", "Vimeo") */
-    site: string;
-    /** Video resolution/size (e.g., 1080, 720) */
-    size: number;
-    /** Type of video (e.g., "Trailer", "Teaser", "Clip", "Featurette", "Behind the Scenes") */
-    type: string;
-    /** Whether this is an official video from the content distributor */
-    official: boolean;
-    /** Publication date and time (ISO 8601 format) */
-    published_at: string;
-    /** Unique video identifier in TMDB */
-    id: string;
-};
-/**
- * Watch provider monetization filters supported by TMDB media discovery endpoints.
- */
-export type WatchMonetizationType = "flatrate" | "free" | "ads" | "rent" | "buy";
-/**
- * Base properties shared between movie and TV show results
- */
-type BaseKnownForItem = {
-    adult: boolean;
-    backdrop_path: string | null;
-    id: number;
-    original_language: string;
-    overview: string;
-    poster_path: string | null;
-    genre_ids: number[];
-    popularity: number;
-    vote_average: number;
-    vote_count: number;
-};
-/**
- * Movie item in known_for array
- */
-export type KnownForMovie = BaseKnownForItem & {
-    /** Media type discriminator */
-    media_type: "movie";
-    /** Movie title (localized) */
-    title: string;
-    /** Original title in the original language */
-    original_title: string;
-    /** Release date in ISO 8601 format (YYYY-MM-DD) */
-    release_date: string;
-    /** Whether a video is available on TMDB */
-    video: boolean;
-};
-/**
- * TV show item in known_for array
- */
-export type KnownForTV = BaseKnownForItem & {
-    /** Media type discriminator */
-    media_type: "tv";
-    /** Series name (localized) */
-    name: string;
-    /** Original series name */
-    original_name: string;
-    /** First air date (YYYY-MM-DD) */
-    first_air_date: string;
-    /** Origin country codes (ISO 3166-1 array) */
-    origin_country: CountryISO3166_1[];
-};
-/**
- * Union type for items in the known_for array (can be either movie or TV show)
- */
-export type KnownForItem = KnownForMovie | KnownForTV;
-/** Available media types on TMDB */
-export type MediaType = "movie" | "tv";
-/**
- * Content rating information for a TV show or movie
- */
-export type ContentRating = {
-    /** Additional content descriptors or advisory warnings (e.g., "violence", "language", "nudity") */
-    descriptors: string[];
-    /** ISO 3166-1 country code where this rating applies */
-    iso_3166_1: string;
-    /** Age or content rating (e.g., "TV-MA", "PG-13", "TV-14", "R") */
-    rating: string;
-};
-/**
- * Individual movie review with author information
- */
-export type Review = {
-    /** Review author's display name */
-    author: string;
-    /** Detailed information about the review author */
-    author_details: ReviewAuthorDetails;
-    /** Full review text content */
-    content: string;
-    /** Timestamp when the review was created (ISO 8601) */
-    created_at: string;
-    /** Unique review identifier */
-    id: string;
-    /** Timestamp of last update (ISO 8601) */
-    updated_at: string;
-    /** URL to the review on TMDB website */
-    url: string;
-};
-/**
- * Author information for a movie review
- */
-export type ReviewAuthorDetails = {
-    /** Author's full name */
-    name: string;
-    /** Author's username on TMDB */
-    username: string;
-    /** Path to author's avatar image (optional) */
-    avatar_path?: string;
-    /** Rating given by the author (0-10 scale, optional) */
-    rating?: number;
-};
-/** Collection of translations for a media item (object with `id` and `translations`). */
-export type TranslationResults<T> = {
-    id: number | string;
-    translations: Translation<T>[];
-};
-/**
- * Translation data for a specific language
- */
-export type Translation<T = unknown> = {
-    /** ISO 3166-1 alpha-2 country code */
-    iso_3166_1: string;
-    /** ISO 639-1 language code */
-    iso_639_1: string;
-    /** Native name of the language */
-    name: string;
-    /** English name of the language */
-    english_name: string;
-    /** Translated media (tv/movie) information */
-    data: T;
-};
-/**
- * Watch provider availability by country
- */
-export type MediaWatchProviders = {
-    /** Movie/TV show identifier */
-    id: number;
-    /** Watch providers grouped by country code */
-    results: Record<CountryISO3166_1, WatchProvider>;
-};
-/**
- * Watch provider options for a specific country
- */
-export type WatchProvider = {
-    /** URL to watch/purchase the movie */
-    link: string;
-    /** Streaming providers (subscription required) */
-    flatrate?: WatchProviderItem[];
-    /** Rental providers */
-    rent?: WatchProviderItem[];
-    /** Purchase providers */
-    buy?: WatchProviderItem[];
-};
-/**
- * Individual watch provider details
- */
-export type WatchProviderItem = {
-    /** Path to provider logo image */
-    logo_path: string;
-    /** Unique provider identifier */
-    provider_id: number;
-    /** Provider name (e.g., "Netflix", "Amazon Prime Video") */
-    provider_name: string;
-    /** Display priority order (lower numbers = higher priority) */
-    display_priority: number;
-};
-export {};

package/dist/types/common/media.js

@@ -1 +0,0 @@
-export {};

package/dist/types/common/pagination.d.ts

@@ -1,6 +0,0 @@
-export type PaginatedResponse<T> = {
-    page: number;
-    total_pages: number;
-    total_results: number;
-    results: T[];
-};

package/dist/types/common/pagination.js

@@ -1 +0,0 @@
-export {};

package/dist/types/common/params.d.ts

@@ -1,27 +0,0 @@
-import { CountryISO3166_1 } from "../config/countries";
-import { Language } from "../config/languages";
-/**
- * Most of the commonly used params for
- * TMDB queries. Defined here for reuse.
- */
-export type TMDBQueryParams = {
-    language?: Language;
-    page?: number;
-    region?: CountryISO3166_1;
-};
-/**
- * Specify a date range with start and end date.
- */
-export type DateRange = {
-    /** Start date for changes in ISO 8601 format (YYYY-MM-DD) */
-    start_date?: string;
-    /** End date for changes in ISO 8601 format (YYYY-MM-DD) */
-    end_date?: string;
-};
-/** Generic utility */
-export type WithParams<T extends keyof TMDBQueryParams> = Pick<TMDBQueryParams, T>;
-export type WithLanguage = WithParams<"language">;
-export type WithPage = WithParams<"page">;
-export type WithRegion = WithParams<"region">;
-export type WithLanguagePage = WithParams<"language" | "page">;
-export type WithPageAndDateRange = WithParams<"page"> & DateRange;

package/dist/types/common/params.js

@@ -1 +0,0 @@
-export {};