@lorenzopant/tmdb 1.17.1 → 1.17.2

package/dist/types/search.d.ts

@@ -1,198 +0,0 @@
-import { Keyword, KnownForItem } from "./common";
-import { CountryISO3166_1, Language } from "./config";
-/**
- * Collection information in search results
- */
-export type CollectionResultItem = {
-    /** Whether the collection contains adult content */
-    adult: boolean;
-    /** Path to backdrop image */
-    backdrop_path: string;
-    /** Unique collection identifier */
-    id: number;
-    /** Collection name (localized) */
-    name: string;
-    /** Original collection name in the original language */
-    original_name: string;
-    /** Original language of the collection (ISO 639-1 code) */
-    original_language: string;
-    /** Collection overview/description */
-    overview: string;
-    /** Path to poster image */
-    poster_path?: string | null;
-};
-/**
- * Company information in search results
- */
-export type CompanyResultItem = {
-    /** Unique company identifier */
-    id: number;
-    /** Path to company logo image */
-    logo_path?: string | null;
-    /** Company name */
-    name: string;
-    /** ISO 3166-1 country code of company's origin */
-    origin_country: CountryISO3166_1;
-};
-/**
- * Keyword information in search results
- */
-export type KeywordResultItem = Keyword;
-/**
- * Person information in search results
- */
-export type PersonResultItem = {
-    /** Whether the person is flagged as adult content creator */
-    adult: boolean;
-    /** Gender code: 0 = Not specified, 1 = Female, 2 = Male, 3 = Non-binary */
-    gender: number;
-    /** Unique person identifier */
-    id: number;
-    /** Primary department the person is known for (e.g. "Acting", "Directing") */
-    known_for_department: string;
-    /** Localized display name */
-    name: string;
-    /** Original name, typically in the person's native language */
-    original_name: string;
-    /** TMDB popularity score based on views, votes, and activity */
-    popularity: number;
-    /** Path to person's profile image */
-    profile_path?: string | null;
-    /** List of notable movies or TV shows the person is known for */
-    known_for: KnownForItem[];
-};
-/**
- * A single TV series result as returned by TMDB APIs.
- *
- * Contains identifiers, localized and original titles, image path references,
- * release and origin information, genre ids, and popularity/vote statistics.
- * It is a partial representation of the TVDetails type.
- */
-export type TVSeriesResultItem = {
-    /** Relative path to the backdrop image for the series (nullable on some responses). */
-    backdrop_path?: string | null;
-    /** First air date of the series (YYYY-MM-DD). */
-    first_air_date: string;
-    /** Array of genre ids associated with the series. */
-    genre_ids: number[];
-    /** Unique TMDB id for the series. */
-    id: number;
-    /** Series name (localized). */
-    name: string;
-    /** Origin country codes for the series (ISO 3166-1). */
-    origin_country: CountryISO3166_1[];
-    /** Original language code (ISO 639-1). */
-    original_language: string;
-    /** Brief synopsis/overview of the series. */
-    overview: string;
-    /** Popularity score as returned by TMDB. */
-    popularity: number;
-    /** Relative path to the poster image for the series (nullable on some responses). */
-    poster_path?: string | null;
-    /** Average vote score for the series. */
-    vote_average: number;
-    /** Total number of votes the series has received. */
-    vote_count: number;
-    /** Original (non-localized) title of the series. */
-    original_name: string;
-};
-/**
- * Simplified movie information used in lists and search results
- */
-export type MovieResultItem = {
-    /** Path to backdrop image */
-    backdrop_path?: string | null;
-    /** Unique movie identifier */
-    id: number;
-    /** Movie title (localized) */
-    title: string;
-    /** Original title in the original language */
-    original_title: string;
-    /** Plot synopsis/overview */
-    overview: string;
-    /** Path to poster image */
-    poster_path?: string | null;
-    /** Whether the movie is marked as adult content */
-    adult: boolean;
-    /** Original language of the movie (ISO 639-1 code) */
-    original_language: string;
-    /** Array of genre IDs (use /genre/movie/list to map to names) */
-    genre_ids: number[];
-    /** Popularity score calculated by TMDB */
-    popularity: number;
-    /** Release date in ISO 8601 format (YYYY-MM-DD) */
-    release_date: string;
-    /** Whether a video is available on TMDB */
-    video: boolean;
-    /** Average user rating (0-10 scale) */
-    vote_average: number;
-    /** Total number of votes received */
-    vote_count: number;
-};
-/**
- * A single result item from the multi-search endpoint.
- * Discriminated on `media_type`.
- */
-export type MultiSearchResultItem = (MovieResultItem & {
-    media_type: "movie";
-}) | (TVSeriesResultItem & {
-    media_type: "tv";
-}) | (PersonResultItem & {
-    media_type: "person";
-});
-/**
- * Parameters for searching movies
- */
-export type SearchMoviesParams = {
-    /** Search query text */
-    query: string;
-    /** Include adult (18+) content in results (default: false) */
-    include_adult?: boolean;
-    /** ISO 639-1 language code with optional region (e.g., "en-US") */
-    language?: Language;
-    /** Page number for paginated results (default: 1) */
-    page?: number;
-    /** Filter results by primary release year (YYYY format) */
-    primary_release_year?: string;
-    /** ISO 3166-1 country code to filter results by region */
-    region?: CountryISO3166_1;
-    /** Filter results by any release year (YYYY format) */
-    year?: string;
-};
-/**
- * Parameters for searching collections
- */
-export type SearchCollectionsParams = Omit<SearchMoviesParams, "primary_release_year" | "year">;
-/**
- * Parameters for searching keywords
- */
-export type SearchKeywordsParams = Pick<SearchMoviesParams, "query" | "page">;
-/**
- * Parameters for searching companies
- */
-export type SearchCompanyParams = Pick<SearchMoviesParams, "query" | "page">;
-/**
- * Parameters for searching people
- */
-export type SearchPersonParams = Pick<SearchMoviesParams, "query" | "page" | "include_adult" | "language">;
-/**
- * Parameters for searching TV series
- */
-export type SearchTVSeriesParams = {
-    /** Search query text */
-    query: string;
-    /** Include adult (18+) content in results (default: false) */
-    include_adult?: boolean;
-    /** ISO 639-1 language code with optional region (e.g., "en-US") */
-    language?: Language;
-    /** Page number for paginated results (default: 1) */
-    page?: number;
-    /** Filter by first air date year (1000–9999) */
-    first_air_date_year?: number;
-    /** Filter by any air date year, including episodes (1000–9999) */
-    year?: number;
-};
-/**
- * Parameters for multi-search (movies, TV shows, and people in a single request)
- */
-export type SearchMultiParams = Pick<SearchTVSeriesParams, "query" | "include_adult" | "language" | "page">;

package/dist/types/search.js

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

package/dist/types/trending.d.ts

@@ -1,55 +0,0 @@
-import type { Language } from "./config/languages";
-import type { MovieResultItem, PersonResultItem, TVSeriesResultItem } from "./search";
-/** Time window for trending data */
-export type TrendingTimeWindow = "day" | "week";
-/**
- * Query parameters for all trending endpoints.
- * `time_window` is embedded in the URL path; `language` is a query param.
- */
-export type TrendingParams = {
-    /** Time window for trending data. `"day"` returns the last 24 hours, `"week"` returns the last 7 days. */
-    time_window: TrendingTimeWindow;
-    /** Language for localised results (ISO 639-1 + ISO 3166-1, e.g. `"en-US"`). */
-    language?: Language;
-};
-/**
- * A trending movie result.
- * Extends {@link MovieResultItem} with the `media_type` discriminator.
- */
-export type TrendingMovieResult = MovieResultItem & {
-    /** Media type discriminator — always `"movie"` for this endpoint. */
-    media_type: "movie";
-};
-/**
- * A trending TV series result.
- * Extends {@link TVSeriesResultItem} with the `media_type` discriminator.
- */
-export type TrendingTVResult = TVSeriesResultItem & {
-    /** Media type discriminator — always `"tv"` for this endpoint. */
-    media_type: "tv";
-};
-/**
- * A trending person result.
- * Extends {@link PersonResultItem} with the `media_type` discriminator.
- */
-export type TrendingPersonResult = PersonResultItem & {
-    /** Media type discriminator — always `"person"` for this endpoint. */
-    media_type: "person";
-};
-/**
- * Union of all trending result types returned by the `trending.all()` endpoint.
- * Discriminated by `media_type`.
- *
- * @example
- * ```ts
- * import { isTrendingMovie, isTrendingTV } from "@lorenzopant/tmdb";
- *
- * const results = await tmdb.trending.all({ time_window: "day" });
- * for (const item of results.results) {
- *   if (item.media_type === "movie") console.log(item.title);
- *   if (item.media_type === "tv") console.log(item.name);
- *   if (item.media_type === "person") console.log(item.name);
- * }
- * ```
- */
-export type TrendingAllResult = TrendingMovieResult | TrendingTVResult | TrendingPersonResult;

package/dist/types/trending.js

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

package/dist/types/tv-episode-groups.d.ts

@@ -1,63 +0,0 @@
-import { NetworkItem } from "./networks";
-import { TVEpisode } from "./tv-episodes";
-/**
- * Full details for a TV episode group, including grouped episode lists.
- */
-export type TVEpisodeGroupDetails = {
-    /** Description of the episode group */
-    description: string;
-    /** Total number of episodes across all groups */
-    episode_count: number;
-    /** Number of group entries in this episode group */
-    group_count: number;
-    /** Unique episode group identifier */
-    id: string;
-    /** Name of the episode group */
-    name: string;
-    /** Network associated with the episode group, if available */
-    network: NetworkItem | null;
-    /** Grouping strategy type (e.g., numbered by season, collections, etc.) */
-    type: TVEpisodeGroupType;
-    /** Grouped episode entries */
-    groups: TVEpisodeGroupDetailsItem[];
-};
-/**
- * A group within an episode group (e.g., a season-like grouping).
- */
-export type TVEpisodeGroupDetailsItem = {
-    /** Unique group identifier */
-    id: string;
-    /** Group name */
-    name: string;
-    /** Display order */
-    order: number;
-    /** Whether the group is locked on TMDB */
-    locked: boolean;
-    /** Episodes included in this group */
-    episodes: TVEpisodeGroupEpisode[];
-};
-/**
- * A simplified TV episode item returned in episode group details.
- */
-export type TVEpisodeGroupEpisode = Omit<TVEpisode, "guest_stars" | "runtime"> & {
-    /** Production code for the episode, if available */
-    production_code?: string | null;
-    /** Path to the episode still image, if available */
-    still_path?: string | null;
-};
-/**
- * Supported episode group type identifiers.
- */
-export declare enum TVEpisodeGroupType {
-    OriginalAirDate = 1,
-    Absolute = 2,
-    Dvd = 3,
-    Digital = 4,
-    StoryArc = 5,
-    Production = 6,
-    TV = 7
-}
-export type TVEpisodeGroupParams = {
-    /** Episode group identifier */
-    episode_group_id: string;
-};

package/dist/types/tv-episode-groups.js

@@ -1,13 +0,0 @@
-/**
- * Supported episode group type identifiers.
- */
-export var TVEpisodeGroupType;
-(function (TVEpisodeGroupType) {
-    TVEpisodeGroupType[TVEpisodeGroupType["OriginalAirDate"] = 1] = "OriginalAirDate";
-    TVEpisodeGroupType[TVEpisodeGroupType["Absolute"] = 2] = "Absolute";
-    TVEpisodeGroupType[TVEpisodeGroupType["Dvd"] = 3] = "Dvd";
-    TVEpisodeGroupType[TVEpisodeGroupType["Digital"] = 4] = "Digital";
-    TVEpisodeGroupType[TVEpisodeGroupType["StoryArc"] = 5] = "StoryArc";
-    TVEpisodeGroupType[TVEpisodeGroupType["Production"] = 6] = "Production";
-    TVEpisodeGroupType[TVEpisodeGroupType["TV"] = 7] = "TV";
-})(TVEpisodeGroupType || (TVEpisodeGroupType = {}));

package/dist/types/tv-episodes.d.ts

@@ -1,98 +0,0 @@
-import { Cast, Crew, ImageItem, ImagesResult, TranslationResults, VideoResults, WithLanguage, WithParams } from "./common";
-import { Language } from "./config";
-import { TVSeasonBaseParams } from "./tv-seasons";
-import { TVExternalIDs } from "./tv-series";
-import { Prettify } from "./utility";
-/**
- * Represents a single episode of a TV series from the TMDB API.
- * Contains detailed metadata including crew, guest stars, and voting stats.
- */
-export type TVEpisode = {
-    /** ISO 8601 formatted date when the episode first aired (e.g. `"2023-05-15"`) */
-    air_date: string;
-    /** Array of crew members who worked on this specific episode */
-    crew: Crew[];
-    /** Sequential number of this episode within its season (1-based) */
-    episode_number: number;
-    /** Array of guest stars appearing in this episode (subset of cast without `cast_id`) */
-    guest_stars: Omit<Cast, "cast_id">[];
-    /** Episode title or name */
-    name: string;
-    /** Episode synopsis or description */
-    overview: string;
-    /** Unique TMDB identifier for this episode */
-    id: number;
-    /** Production code assigned by the production company, if available */
-    production_code?: string | null;
-    /** Runtime of the episode in minutes */
-    runtime: number;
-    /** Season number this episode belongs to (1-based) */
-    season_number: number;
-    /** Relative path to the episode still/image (e.g. `"/abc123.jpg"`), or null if none */
-    still_path?: string | null;
-    /** Average user rating of the episode (0-10 scale) */
-    vote_average: number;
-    /** Total number of user votes for the episode */
-    vote_count: number;
-};
-/**
- * Available append-to-response options for TV episode details.
- * These allow fetching additional related data in a single API request.
- */
-export type TVEpisodeAppendToResponseNamespace = "credits" | "external_ids" | "images" | "translations" | "videos";
-/**
- * Maps append-to-response keys to their corresponding response types.
- */
-export type TVEpisodeAppendableMap = {
-    credits: TVEpisodeCredits;
-    external_ids: TVEpisodeExternalIDs;
-    images: TVEpisodeImages;
-    translations: TVEpisodeTranslations;
-    videos: TVEpisodeVideos;
-};
-/**
- * TV show details with additional appended data based on the requested namespaces.
- * @template T - Array of append-to-response namespace keys to include
- */
-export type TVEpisodeDetailsWithAppends<T extends readonly TVEpisodeAppendToResponseNamespace[]> = TVEpisode & {
-    [K in T[number]]: TVEpisodeAppendableMap[K];
-};
-export type TVEpisodeCredits = {
-    id: number | string;
-    cast: Omit<Cast, "cast_id">[];
-    crew: Crew[];
-    guest_stars: Omit<Cast, "cast_id">[];
-};
-export type TVEpisodeExternalIDs = Omit<TVExternalIDs, "facebook_id" | "instagram_id" | "twitter_id">;
-export type TVEpisodeImages = ImagesResult<ImageItem, "stills">;
-export type TVEpisodeTranslations = TranslationResults<TVEpisodeTranslationData>;
-export type TVEpisodeTranslationData = {
-    name?: string | null;
-    overview?: string | null;
-};
-export type TVEpisodeVideos = VideoResults;
-/**
- * Almost every query within the TV Episodes domain
- * will take this required param to identify the
- * tv show episode.
- */
-export type TVEpisodeBaseParams = TVSeasonBaseParams & {
-    /** Episode number */
-    episode_number: number;
-};
-/** Uniquely identifies an episode across different tv shows. */
-export type TVEpisodeId = {
-    episode_id: string | number;
-};
-/**
- * Parameters for fetching TV episode details with optional additional data appended.
- */
-export type TVEpisodeDetailsParams = Prettify<TVEpisodeBaseParams & {
-    append_to_response?: TVEpisodeAppendToResponseNamespace[];
-} & WithParams<"language">>;
-/** Parameters for tv episode credits endpoint */
-export type TVEpisodeCreditsParams = TVEpisodeBaseParams & WithLanguage;
-export type TVEpisodeImagesParams = TVEpisodeBaseParams & WithLanguage & {
-    /** 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/tv-episodes.js

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

package/dist/types/tv-seasons.d.ts

@@ -1,133 +0,0 @@
-import { Cast, Crew, DateRange, ImageItem, ImagesResult, TranslationResults, VideoResults, WithLanguage, WithParams } from "./common";
-import { Language } from "./config";
-import { TVAggregateCredits, TVBaseParam, TVEpisodeItem, TVExternalIDs } from "./tv-series";
-import { MediaWatchProviders } from "./common/media";
-import { NetworkItem } from "./networks";
-import { LiteralUnion, Prettify } from "./utility";
-/**
- * Almost every query within the TV Series Seasons domain
- * will take this required param to identify the
- * tv show season.
- */
-export type TVSeasonBaseParams = TVBaseParam & {
-    /** The Season */
-    season_number: number;
-};
-/** Uniquely identifies a season across different tv shows. */
-export type TVSeasonId = {
-    season_id: string | number;
-};
-/**
- * Represents a single episode within a TV season from the TMDB API.
- * Extends {@link TVEpisodeItem} (rather than `TVEpisode`) with crew, guest stars, and episode type.
- *
- * NOTE: `TVEpisode` is intentionally not used here to avoid a circular dependency:
- * `tv-episodes.ts` imports `TVSeasonBaseParams` from this file, so importing
- * `TVEpisode` back would form a cycle. `TVEpisodeItem` carries the same scalar
- * fields (including `show_id`) and produces an identical runtime shape.
- */
-export type TVSeasonEpisode = TVEpisodeItem & {
-    /** Array of crew members for this episode */
-    crew: Crew[];
-    /** Episode type */
-    episode_type: LiteralUnion<"standard" | "finale">;
-    /** Array of guest stars in this episode */
-    guest_stars: Omit<Cast, "cast_id">[];
-};
-/**
- * Detailed information about a TV season returned by the TMDB API.
- */
-export type TVSeason = {
-    /** ISO 8601 date when the season first aired */
-    air_date?: string | null;
-    /** Array of episodes in this season */
-    episodes: TVSeasonEpisode[];
-    /** Unique TMDB identifier for the season */
-    id: number;
-    /** Season name */
-    name: string;
-    /** Networks that broadcast this season */
-    networks: NetworkItem[];
-    /** Season overview/description */
-    overview: string;
-    /** Relative path to the season poster */
-    poster_path?: string | null;
-    /** Season number within the TV show */
-    season_number: number;
-    /** Average user rating (0–10) */
-    vote_average: number;
-};
-/**
- * Available append-to-response options for TV season details.
- * These allow fetching additional related data in a single API request.
- */
-export type TVSeasonAppendToResponseNamespace = "aggregate_credits" | "credits" | "external_ids" | "images" | "translations" | "videos" | "watch_providers";
-/**
- * Maps append-to-response keys to their corresponding response types.
- */
-export type TVSeasonAppendableMap = {
-    aggregate_credits: TVSeasonAggregateCredits;
-    credits: TVSeasonCredits;
-    external_ids: TVSeasonExternalIDs;
-    images: TVSeasonImages;
-    translations: TVSeasonTranslations;
-    videos: TVSeasonVideos;
-    watch_providers: MediaWatchProviders;
-};
-/**
- * TV season details with additional appended data based on the requested namespaces.
- * @template T - Array of append-to-response namespace keys to include
- */
-export type TVSeasonDetailsWithAppends<T extends readonly TVSeasonAppendToResponseNamespace[]> = TVSeason & {
-    [K in T[number]]: TVSeasonAppendableMap[K];
-};
-/** Aggregate cast and crew credits for a TV season across all its episodes. */
-export type TVSeasonAggregateCredits = TVAggregateCredits;
-/** Season change history, using the same structure as other TMDB change responses. */
-export type TVSeasonChanges = import("./common").Changes;
-/** Credits (cast & crew) for a TV season, mirroring the series-level credits shape. */
-export type TVSeasonCredits = {
-    /** TMDB unique identifier */
-    id: number;
-    /** Cast members */
-    cast: Cast[];
-    /** Crew members */
-    crew: Crew[];
-};
-/** External platform identifiers for a TV season (subset of TV series external IDs). */
-export type TVSeasonExternalIDs = Pick<TVExternalIDs, "id" | "freebase_mid" | "freebase_id" | "tvdb_id" | "tvrage_id" | "wikidata_id">;
-/**
- * Images associated with a TV season.
- * Contains posters only.
- */
-export type TVSeasonImages = ImagesResult<ImageItem, "posters">;
-/** Translation data for a TV season. */
-export type TVSeasonTranslationData = {
-    name?: string | null;
-    overview?: string | null;
-};
-/** Collection of all available translations for a TV season. */
-export type TVSeasonTranslations = TranslationResults<TVSeasonTranslationData>;
-/** Videos (trailers, teasers, clips) for a TV season. */
-export type TVSeasonVideos = VideoResults;
-/** Parameters for the season details endpoint. */
-export type TVSeasonDetailsParams = Prettify<TVSeasonBaseParams & {
-    append_to_response?: TVSeasonAppendToResponseNamespace[];
-} & WithParams<"language">>;
-/** Parameters for the season aggregate credits endpoint. */
-export type TVSeasonAggregateCreditsParams = TVSeasonBaseParams & WithLanguage;
-/** Parameters for the season credits endpoint. */
-export type TVSeasonCreditsParams = TVSeasonBaseParams & WithLanguage;
-/** Parameters for the season images endpoint, with optional language filtering. */
-export type TVSeasonImagesParams = TVSeasonBaseParams & WithLanguage & {
-    /** 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")[];
-};
-/** Parameters for the season videos endpoint, with optional language filtering. */
-export type TVSeasonVideosParams = TVSeasonBaseParams & WithLanguage & {
-    include_video_language?: string;
-};
-/** Parameters for the season watch providers endpoint. */
-export type TVSeasonWatchProvidersParams = TVSeasonBaseParams & WithLanguage;
-/** Parameters for the season changes endpoint. */
-export type TVSeasonChangesParams = TVSeasonId & Prettify<WithParams<"page"> & DateRange>;

package/dist/types/tv-seasons.js

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