tmdb-kit 1.0.0 → 1.1.0

package/dist/resources/images.d.ts

@@ -0,0 +1,17 @@
+import type { TMDBTransport } from '../http.js';
+import type { ImageSize } from '../types.js';
+/** Function that transforms a TMDB image URL (e.g. for CDN proxying). */
+export type ImageUrlTransform = (url: string) => string;
+/**
+ * Helper for constructing TMDB image URLs from API path values.
+ *
+ * Obtained via `client.images`. Supports optional URL transforms for
+ * routing image requests through a CDN or proxy.
+ */
+export declare class ImagesHelper {
+    #private;
+    constructor(transport: TMDBTransport, transform?: ImageUrlTransform);
+    url(path: string | null | undefined, size?: ImageSize, options?: {
+        transform?: ImageUrlTransform;
+    }): string | null;
+}

package/dist/resources/movies.d.cts

@@ -0,0 +1,21 @@
+import type { TMDBTransport } from '../http.cjs';
+import type { CreditsResponse, ImageQueryOptions, ImagesResponse, ListOptions, MovieDetails, MovieDetailsOptions, MovieSummary, PagedResponse, TMDBObject, VideosResponse } from '../types.cjs';
+/**
+ * Access TMDB movie endpoints (popular, top-rated, details, credits, etc.).
+ *
+ * Obtained via `client.movies`.
+ */
+export declare class MoviesResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    popular(options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    topRated(options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    nowPlaying(options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    upcoming(options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    details<TAppend extends TMDBObject = TMDBObject>(movieId: number, options?: MovieDetailsOptions): Promise<MovieDetails & TAppend>;
+    credits(movieId: number, options?: Pick<ListOptions, 'language'>): Promise<CreditsResponse>;
+    images(movieId: number, options?: ImageQueryOptions): Promise<ImagesResponse>;
+    recommendations(movieId: number, options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    similar(movieId: number, options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    videos(movieId: number, options?: Pick<ListOptions, 'language'>): Promise<VideosResponse>;
+}

package/dist/resources/movies.d.ts

@@ -0,0 +1,21 @@
+import type { TMDBTransport } from '../http.js';
+import type { CreditsResponse, ImageQueryOptions, ImagesResponse, ListOptions, MovieDetails, MovieDetailsOptions, MovieSummary, PagedResponse, TMDBObject, VideosResponse } from '../types.js';
+/**
+ * Access TMDB movie endpoints (popular, top-rated, details, credits, etc.).
+ *
+ * Obtained via `client.movies`.
+ */
+export declare class MoviesResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    popular(options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    topRated(options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    nowPlaying(options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    upcoming(options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    details<TAppend extends TMDBObject = TMDBObject>(movieId: number, options?: MovieDetailsOptions): Promise<MovieDetails & TAppend>;
+    credits(movieId: number, options?: Pick<ListOptions, 'language'>): Promise<CreditsResponse>;
+    images(movieId: number, options?: ImageQueryOptions): Promise<ImagesResponse>;
+    recommendations(movieId: number, options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    similar(movieId: number, options?: ListOptions): Promise<PagedResponse<MovieSummary>>;
+    videos(movieId: number, options?: Pick<ListOptions, 'language'>): Promise<VideosResponse>;
+}

package/dist/resources/people.d.cts

@@ -0,0 +1,14 @@
+import type { TMDBTransport } from '../http.cjs';
+import type { LanguageOptions, ListOptions, PagedResponse, PersonCombinedCreditsResponse, PersonDetails, PersonSummary } from '../types.cjs';
+/**
+ * Access TMDB person (actor, director, etc.) endpoints.
+ *
+ * Obtained via `client.people`.
+ */
+export declare class PeopleResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    popular(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<PersonSummary>>;
+    details(personId: number, options?: LanguageOptions): Promise<PersonDetails>;
+    combinedCredits(personId: number, options?: LanguageOptions): Promise<PersonCombinedCreditsResponse>;
+}

package/dist/resources/people.d.ts

@@ -0,0 +1,14 @@
+import type { TMDBTransport } from '../http.js';
+import type { LanguageOptions, ListOptions, PagedResponse, PersonCombinedCreditsResponse, PersonDetails, PersonSummary } from '../types.js';
+/**
+ * Access TMDB person (actor, director, etc.) endpoints.
+ *
+ * Obtained via `client.people`.
+ */
+export declare class PeopleResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    popular(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<PersonSummary>>;
+    details(personId: number, options?: LanguageOptions): Promise<PersonDetails>;
+    combinedCredits(personId: number, options?: LanguageOptions): Promise<PersonCombinedCreditsResponse>;
+}

package/dist/resources/search.d.cts

@@ -0,0 +1,15 @@
+import type { TMDBTransport } from '../http.cjs';
+import type { MovieSearchOptions, MovieSearchResult, MultiSearchOptions, PagedResponse, PersonSearchResult, SearchMultiResult, TVSearchOptions, TVSearchResult } from '../types.cjs';
+/**
+ * Search TMDB for movies, TV shows, people, or all media types.
+ *
+ * Obtained via `client.search`.
+ */
+export declare class SearchResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    movies(query: string, options?: MovieSearchOptions): Promise<PagedResponse<MovieSearchResult>>;
+    tv(query: string, options?: TVSearchOptions): Promise<PagedResponse<TVSearchResult>>;
+    people(query: string, options?: MultiSearchOptions): Promise<PagedResponse<PersonSearchResult>>;
+    multi(query: string, options?: MultiSearchOptions): Promise<PagedResponse<SearchMultiResult>>;
+}

package/dist/resources/search.d.ts

@@ -0,0 +1,15 @@
+import type { TMDBTransport } from '../http.js';
+import type { MovieSearchOptions, MovieSearchResult, MultiSearchOptions, PagedResponse, PersonSearchResult, SearchMultiResult, TVSearchOptions, TVSearchResult } from '../types.js';
+/**
+ * Search TMDB for movies, TV shows, people, or all media types.
+ *
+ * Obtained via `client.search`.
+ */
+export declare class SearchResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    movies(query: string, options?: MovieSearchOptions): Promise<PagedResponse<MovieSearchResult>>;
+    tv(query: string, options?: TVSearchOptions): Promise<PagedResponse<TVSearchResult>>;
+    people(query: string, options?: MultiSearchOptions): Promise<PagedResponse<PersonSearchResult>>;
+    multi(query: string, options?: MultiSearchOptions): Promise<PagedResponse<SearchMultiResult>>;
+}

package/dist/resources/trending.d.cts

@@ -0,0 +1,23 @@
+import type { TMDBTransport } from '../http.cjs';
+import type { ListOptions, MovieSummary, PagedResponse, PersonSummary, TrendingResult, TrendingTimeWindow, TVSummary } from '../types.cjs';
+type TrendingOptions = Omit<ListOptions, 'region'>;
+/**
+ * Access TMDB trending content (movies, TV, people) for day/week windows.
+ *
+ * Obtained via `client.trending`.
+ */
+export declare class TrendingResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    all(timeWindow?: TrendingTimeWindow, options?: TrendingOptions): Promise<PagedResponse<TrendingResult>>;
+    movies(timeWindow?: TrendingTimeWindow, options?: TrendingOptions): Promise<PagedResponse<MovieSummary & {
+        media_type?: 'movie';
+    }>>;
+    tv(timeWindow?: TrendingTimeWindow, options?: TrendingOptions): Promise<PagedResponse<TVSummary & {
+        media_type?: 'tv';
+    }>>;
+    people(timeWindow?: TrendingTimeWindow, options?: TrendingOptions): Promise<PagedResponse<PersonSummary & {
+        media_type?: 'person';
+    }>>;
+}
+export {};

package/dist/resources/trending.d.ts

@@ -0,0 +1,23 @@
+import type { TMDBTransport } from '../http.js';
+import type { ListOptions, MovieSummary, PagedResponse, PersonSummary, TrendingResult, TrendingTimeWindow, TVSummary } from '../types.js';
+type TrendingOptions = Omit<ListOptions, 'region'>;
+/**
+ * Access TMDB trending content (movies, TV, people) for day/week windows.
+ *
+ * Obtained via `client.trending`.
+ */
+export declare class TrendingResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    all(timeWindow?: TrendingTimeWindow, options?: TrendingOptions): Promise<PagedResponse<TrendingResult>>;
+    movies(timeWindow?: TrendingTimeWindow, options?: TrendingOptions): Promise<PagedResponse<MovieSummary & {
+        media_type?: 'movie';
+    }>>;
+    tv(timeWindow?: TrendingTimeWindow, options?: TrendingOptions): Promise<PagedResponse<TVSummary & {
+        media_type?: 'tv';
+    }>>;
+    people(timeWindow?: TrendingTimeWindow, options?: TrendingOptions): Promise<PagedResponse<PersonSummary & {
+        media_type?: 'person';
+    }>>;
+}
+export {};

package/dist/resources/tv.d.cts

@@ -0,0 +1,22 @@
+import type { TMDBTransport } from '../http.cjs';
+import type { CreditsResponse, ImageQueryOptions, ImagesResponse, LanguageOptions, ListOptions, PagedResponse, TMDBObject, TVDetails, TVDetailsOptions, TVSeasonDetails, TVSeasonDetailsOptions, TVSummary, VideosResponse } from '../types.cjs';
+/**
+ * Access TMDB TV show endpoints (popular, top-rated, details, seasons, etc.).
+ *
+ * Obtained via `client.tv`.
+ */
+export declare class TVResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    popular(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    topRated(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    airingToday(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    onTheAir(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    details<TAppend extends TMDBObject = TMDBObject>(seriesId: number, options?: TVDetailsOptions): Promise<TVDetails & TAppend>;
+    credits(seriesId: number, options?: LanguageOptions): Promise<CreditsResponse>;
+    images(seriesId: number, options?: ImageQueryOptions): Promise<ImagesResponse>;
+    recommendations(seriesId: number, options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    similar(seriesId: number, options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    videos(seriesId: number, options?: LanguageOptions): Promise<VideosResponse>;
+    seasonDetails<TAppend extends TMDBObject = TMDBObject>(seriesId: number, seasonNumber: number, options?: TVSeasonDetailsOptions): Promise<TVSeasonDetails & TAppend>;
+}

package/dist/resources/tv.d.ts

@@ -0,0 +1,22 @@
+import type { TMDBTransport } from '../http.js';
+import type { CreditsResponse, ImageQueryOptions, ImagesResponse, LanguageOptions, ListOptions, PagedResponse, TMDBObject, TVDetails, TVDetailsOptions, TVSeasonDetails, TVSeasonDetailsOptions, TVSummary, VideosResponse } from '../types.js';
+/**
+ * Access TMDB TV show endpoints (popular, top-rated, details, seasons, etc.).
+ *
+ * Obtained via `client.tv`.
+ */
+export declare class TVResource {
+    #private;
+    constructor(transport: TMDBTransport);
+    popular(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    topRated(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    airingToday(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    onTheAir(options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    details<TAppend extends TMDBObject = TMDBObject>(seriesId: number, options?: TVDetailsOptions): Promise<TVDetails & TAppend>;
+    credits(seriesId: number, options?: LanguageOptions): Promise<CreditsResponse>;
+    images(seriesId: number, options?: ImageQueryOptions): Promise<ImagesResponse>;
+    recommendations(seriesId: number, options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    similar(seriesId: number, options?: Omit<ListOptions, 'region'>): Promise<PagedResponse<TVSummary>>;
+    videos(seriesId: number, options?: LanguageOptions): Promise<VideosResponse>;
+    seasonDetails<TAppend extends TMDBObject = TMDBObject>(seriesId: number, seasonNumber: number, options?: TVSeasonDetailsOptions): Promise<TVSeasonDetails & TAppend>;
+}

package/dist/search-guards.d.cts

@@ -0,0 +1,32 @@
+import type { MovieMultiResult, MovieSearchResult, PersonMultiResult, PersonSearchResult, SearchMultiResult, TVMultiResult, TVSearchResult } from './types.cjs';
+/**
+ * Type guard that narrows a `search.multi()` result to a movie entry.
+ *
+ * The `media_type` field is required on every `/search/multi` payload by
+ * TMDB, so this check is safe at runtime and produces a strictly typed
+ * MovieSummary on the narrowed branch.
+ */
+export declare function isMovieSearchResult(result: SearchMultiResult): result is MovieMultiResult;
+export declare function isMovieSearchResult(result: unknown): result is MovieMultiResult;
+/** Type guard that narrows a `search.multi()` result to a TV entry. */
+export declare function isTVSearchResult(result: SearchMultiResult): result is TVMultiResult;
+export declare function isTVSearchResult(result: unknown): result is TVMultiResult;
+/** Type guard that narrows a `search.multi()` result to a person entry. */
+export declare function isPersonSearchResult(result: SearchMultiResult): result is PersonMultiResult;
+export declare function isPersonSearchResult(result: unknown): result is PersonMultiResult;
+/**
+ * Convenience alias: `isMovieSearchResult` works on a `search.movies()`
+ * result (which already has the narrow type but is also tagged with
+ * `media_type?: 'movie'`), as well as on multi-search results.
+ */
+export declare function isMovie(result: MovieSearchResult | SearchMultiResult): result is MovieMultiResult;
+export declare function isMovie(result: SearchMultiResult): result is MovieMultiResult;
+export declare function isMovie(result: unknown): result is MovieMultiResult;
+/** Type guard that narrows a search result to a TV entry. */
+export declare function isTV(result: TVSearchResult | SearchMultiResult): result is TVMultiResult;
+export declare function isTV(result: SearchMultiResult): result is TVMultiResult;
+export declare function isTV(result: unknown): result is TVMultiResult;
+/** Type guard that narrows a search result to a person entry. */
+export declare function isPerson(result: PersonSearchResult | SearchMultiResult): result is PersonMultiResult;
+export declare function isPerson(result: SearchMultiResult): result is PersonMultiResult;
+export declare function isPerson(result: unknown): result is PersonMultiResult;

package/dist/search-guards.d.ts

@@ -0,0 +1,32 @@
+import type { MovieMultiResult, MovieSearchResult, PersonMultiResult, PersonSearchResult, SearchMultiResult, TVMultiResult, TVSearchResult } from './types.js';
+/**
+ * Type guard that narrows a `search.multi()` result to a movie entry.
+ *
+ * The `media_type` field is required on every `/search/multi` payload by
+ * TMDB, so this check is safe at runtime and produces a strictly typed
+ * MovieSummary on the narrowed branch.
+ */
+export declare function isMovieSearchResult(result: SearchMultiResult): result is MovieMultiResult;
+export declare function isMovieSearchResult(result: unknown): result is MovieMultiResult;
+/** Type guard that narrows a `search.multi()` result to a TV entry. */
+export declare function isTVSearchResult(result: SearchMultiResult): result is TVMultiResult;
+export declare function isTVSearchResult(result: unknown): result is TVMultiResult;
+/** Type guard that narrows a `search.multi()` result to a person entry. */
+export declare function isPersonSearchResult(result: SearchMultiResult): result is PersonMultiResult;
+export declare function isPersonSearchResult(result: unknown): result is PersonMultiResult;
+/**
+ * Convenience alias: `isMovieSearchResult` works on a `search.movies()`
+ * result (which already has the narrow type but is also tagged with
+ * `media_type?: 'movie'`), as well as on multi-search results.
+ */
+export declare function isMovie(result: MovieSearchResult | SearchMultiResult): result is MovieMultiResult;
+export declare function isMovie(result: SearchMultiResult): result is MovieMultiResult;
+export declare function isMovie(result: unknown): result is MovieMultiResult;
+/** Type guard that narrows a search result to a TV entry. */
+export declare function isTV(result: TVSearchResult | SearchMultiResult): result is TVMultiResult;
+export declare function isTV(result: SearchMultiResult): result is TVMultiResult;
+export declare function isTV(result: unknown): result is TVMultiResult;
+/** Type guard that narrows a search result to a person entry. */
+export declare function isPerson(result: PersonSearchResult | SearchMultiResult): result is PersonMultiResult;
+export declare function isPerson(result: SearchMultiResult): result is PersonMultiResult;
+export declare function isPerson(result: unknown): result is PersonMultiResult;