@tdanks2000/tmdb-wrapper 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AccountEndpoint, CertificationEndpoint, ChangeEndpoint, CollectionsEndpoint, ConfigurationEndpoint, CreditsEndpoint, DiscoverEndpoint, FindEndpoint, GenreEndpoint, KeywordsEndpoint, MoviesEndpoint, PeopleEndpoint, ReviewEndpoint, SearchEndpoint, TrendingEndpoint, TvEpisodesEndpoint, TvSeasonsEndpoint, TvShowsEndpoint } from '@/endpoints';
+import { AccountEndpoint, CertificationEndpoint, ChangeEndpoint, CollectionsEndpoint, ConfigurationEndpoint, CreditsEndpoint, DiscoverEndpoint, FindEndpoint, GenreEndpoint, KeywordsEndpoint, MoviesEndpoint, PeopleEndpoint, ReviewEndpoint, SearchEndpoint, TrendingEndpoint, TvEpisodesEndpoint, TvSeasonsEndpoint, TvShowsEndpoint } from './endpoints';
 declare class TMDB {
     constructor(access_token: string);
     account: AccountEndpoint;

package/dist/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TMDB = void 0;
-const endpoints_1 = require("@/endpoints");
+const endpoints_1 = require("./endpoints");
 class TMDB {
     constructor(access_token) {
         this.account = new endpoints_1.AccountEndpoint(access_token);

package/package.json

@@ -27,14 +27,15 @@
   "license": "MIT",
   "private": false,
   "scripts": {
-    "build": "yarn tsc",
+    "build": "pnpm tsc && pnpm tsc-alias",
     "release": "yarn version && npm publish",
-    "preversion": "yarn tsc"
+    "preversion": "pnpm run build"
   },
   "devDependencies": {
     "@types/node": "^20.11.20",
     "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.8",
     "typescript": "^5.3.3"
   },
-  "version": "1.0.0"
+  "version": "1.0.2"
 }

package/src/@types/endpoints/configuration.ts

@@ -15,6 +15,7 @@ export interface Configuration {
 
 export const enum BackdropSizes {
   W300 = 'w300',
+  W500 = 'w500',
   W780 = 'w780',
   W1280 = 'w1280',
   ORIGINAL = 'original',

package/src/@types/endpoints/discover.ts

@@ -29,3 +29,59 @@ export interface TvShowDiscoverResult {
   total_results: number;
   total_pages: number;
 }
+
+export interface DiscoverQueryOptions {
+  language?: string;
+  sort_by?: SortOption;
+  page?: number;
+  'vote_average.gte'?: number;
+  'vote_count.gte'?: number;
+  'vote_count.lte'?: number;
+  'vote_average.lte'?: number;
+  with_watch_providers?: string;
+  watch_region?: string;
+  without_companies?: string;
+  with_watch_monetization_types?: 'flatrate' | 'free' | 'ads' | 'rent' | 'buy';
+  'with_runtime.gte'?: number;
+  'with_runtime.lte'?: number;
+  with_genres?: string;
+  without_genres?: string;
+  with_original_language?: string;
+  without_keywords?: string;
+  with_keywords?: string;
+  with_companies?: string;
+}
+
+export interface MovieQueryOptions extends DiscoverQueryOptions {
+  region?: string;
+  certification_country?: string;
+  certification?: string;
+  'certification.lte'?: string;
+  'certification.gte'?: string;
+  include_adult?: boolean;
+  include_video?: boolean;
+  primary_release_year?: number;
+  'primary_release_date.gte'?: string;
+  'primary_release_date.lte'?: string;
+  'release_date.gte'?: string;
+  'release_date.lte'?: string;
+  with_release_type?: string;
+  year?: number;
+  with_cast?: string;
+  with_crew?: string;
+  with_people?: string;
+}
+
+export interface TvShowQueryOptions extends DiscoverQueryOptions {
+  'air_date.gte'?: string;
+  'air_date.lte'?: string;
+  'first_air_date.gte'?: string;
+  'first_air_date.lte'?: string;
+  first_air_date_year?: number;
+  timezone?: string;
+  with_networks?: string;
+  include_null_first_air_dates?: boolean;
+  screened_theatrically?: boolean;
+  with_status?: string;
+  with_type?: string;
+}

package/src/@types/endpoints/genre.ts

@@ -0,0 +1,3 @@
+export interface Genres {
+  genres: Array<{ id: number; name: string }>;
+}

package/src/@types/endpoints/index.ts

@@ -7,6 +7,7 @@ export * from './configuration';
 export * from './credits';
 export * from './discover';
 export * from './find';
+export * from './genre';
 export * from './keywords';
 export * from './movies';
 export * from './networks';

package/src/@types/endpoints/movies.ts

@@ -1,4 +1,4 @@
-import { Genre, Movie, ProductionCompany, ProductionCountry, SpokenLanguage } from '..';
+import { Genre, LanguageOption, Movie, ProductionCompany, ProductionCountry, SpokenLanguage } from '..';
 
 export interface BelongsToCollection {
   id: number;
@@ -160,3 +160,10 @@ export type MovieChangeValue =
       credit_id: string;
     }
   | unknown;
+
+export interface MoviesImageSearchOptions extends LanguageOption {
+  /**
+   * a list of ISO-639-1 values to query
+   */
+  include_image_language?: string[];
+}

package/src/@types/endpoints/search.ts

@@ -1,4 +1,4 @@
-import { MovieWithMediaType, PersonWithMediaType, TVWithMediaType } from '..';
+import { LanguageOption, MovieWithMediaType, PageOption, PersonWithMediaType, RegionOption, TVWithMediaType } from '..';
 
 export interface Search<T> {
   page: number;
@@ -8,3 +8,32 @@ export interface Search<T> {
 }
 
 export type MultiSearchResult = MovieWithMediaType | TVWithMediaType | PersonWithMediaType;
+
+export interface SearchOptions {
+  query: string;
+  page?: number;
+}
+
+export interface MovieSearchOptions extends SearchOptions, LanguageOption, PageOption, RegionOption {
+  include_adult?: boolean;
+  year?: number;
+  primary_release_year?: number;
+}
+
+export interface CollectionSearchOptions extends SearchOptions, LanguageOption, PageOption, RegionOption {
+  include_adult?: boolean;
+}
+
+export interface TvSearchOptions extends SearchOptions, LanguageOption, PageOption {
+  include_adult?: boolean;
+  year?: number;
+  first_air_date_year?: number;
+}
+
+export interface PeopleSearchOptions extends SearchOptions, LanguageOption, PageOption {
+  include_adult?: boolean;
+}
+
+export interface MultiSearchOptions extends SearchOptions, LanguageOption, PageOption {
+  include_adult?: boolean;
+}

package/src/@types/endpoints/tvEpisode.ts

@@ -1,4 +1,4 @@
-import { Credits, Crew } from '..';
+import { Credits, Crew, LanguageOption } from '..';
 
 export interface EpisodeSelection {
   tvShowID: number;
@@ -56,3 +56,17 @@ export interface TvEpisodeTranslations {
 }
 
 export type TvEpisodeChangeValue = string | unknown;
+
+export interface TvEpisodeImageSearchOptions extends LanguageOption {
+  /**
+   * a list of ISO-639-1 values to query
+   */
+  include_image_language?: string[];
+}
+
+export interface TvEpisodeVideoSearchOptions extends LanguageOption {
+  /**
+   * a list of ISO-639-1 values to query
+   */
+  include_video_language?: string[];
+}

package/src/@types/endpoints/tvSeasons.ts

@@ -1,4 +1,4 @@
-import { Episode } from '..';
+import { Episode, LanguageOption } from '..';
 
 export interface SeasonSelection {
   tvShowID: number;
@@ -21,3 +21,17 @@ export type TvSeasonChangeValue =
       episode_id: number;
       episode_number: number;
     };
+
+export interface TvSeasonImageSearchOptions extends LanguageOption {
+  /**
+   * a list of ISO-639-1 values to query
+   */
+  include_image_language?: string[];
+}
+
+export interface TvSeasonVideoSearchOptions extends LanguageOption {
+  /**
+   * a list of ISO-639-1 values to query
+   */
+  include_video_language?: string[];
+}

package/src/endpoints/account.ts

@@ -1,10 +1,21 @@
 import { AccountDetails, BaseEndpoint } from '@/@types';
 
+/**
+ * Represents an endpoint for retrieving account details.
+ */
 export class AccountEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new AccountEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves account details asynchronously.
+   * @returns {Promise<AccountDetails>} A Promise that resolves with the account details.
+   */
   async details(): Promise<AccountDetails> {
     return await this.api.get('/account');
   }

package/src/endpoints/certification.ts

@@ -1,14 +1,29 @@
 import { BaseEndpoint, Certifications } from '@/@types';
 
+/**
+ * Represents an endpoint for retrieving certifications for movies and TV shows.
+ */
 export class CertificationEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new CertificationEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(protected readonly access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves certifications for movies asynchronously.
+   * @returns {Promise<Certifications>} A Promise that resolves with the certifications for movies.
+   */
   async movies(): Promise<Certifications> {
     return await this.api.get<Certifications>('/certification/movie/list');
   }
 
+  /**
+   * Retrieves certifications for TV shows asynchronously.
+   * @returns {Promise<Certifications>} A Promise that resolves with the certifications for TV shows.
+   */
   async tv(): Promise<Certifications> {
     return await this.api.get<Certifications>('/certification/tv/list');
   }

package/src/endpoints/changes.ts

@@ -1,19 +1,41 @@
 import { BaseEndpoint, ChangeOption, MediaChanges } from '@/@types';
 
+/**
+ * Represents an endpoint for retrieving changes in movies, TV shows, and persons.
+ */
 export class ChangeEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new ChangeEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(protected readonly access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves changes in movies asynchronously.
+   * @param {ChangeOption} [options] - Optional parameters for filtering the changes.
+   * @returns {Promise<MediaChanges>} A Promise that resolves with the changes in movies.
+   */
   async movies(options?: ChangeOption): Promise<MediaChanges> {
-    return await this.api.get<MediaChanges>(`/movie/changes`, options);
+    return await this.api.get<MediaChanges>('/movie/changes', options);
   }
 
+  /**
+   * Retrieves changes in TV shows asynchronously.
+   * @param {ChangeOption} [options] - Optional parameters for filtering the changes.
+   * @returns {Promise<MediaChanges>} A Promise that resolves with the changes in TV shows.
+   */
   async tv(options?: ChangeOption): Promise<MediaChanges> {
-    return await this.api.get<MediaChanges>(`/tv/changes`, options);
+    return await this.api.get<MediaChanges>('/tv/changes', options);
   }
 
+  /**
+   * Retrieves changes related to persons asynchronously.
+   * @param {ChangeOption} [options] - Optional parameters for filtering the changes.
+   * @returns {Promise<MediaChanges>} A Promise that resolves with the changes related to persons.
+   */
   async person(options?: ChangeOption): Promise<MediaChanges> {
-    return await this.api.get<MediaChanges>(`/person/change`, options);
+    return await this.api.get<MediaChanges>('/person/change', options);
   }
 }

package/src/endpoints/collections.ts

@@ -9,15 +9,34 @@ import {
 
 const BASE_COLLECTION = '/collection';
 
+/**
+ * Represents an endpoint for accessing collections and their details.
+ */
 export class CollectionsEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new CollectionsEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(protected readonly access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves details of a specific collection asynchronously.
+   * @param {number} id - The ID of the collection.
+   * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+   * @returns {Promise<DetailedCollection>} A Promise that resolves with the detailed information of the collection.
+   */
   async details(id: number, options?: LanguageOption): Promise<DetailedCollection> {
     return await this.api.get<DetailedCollection>(`${BASE_COLLECTION}/${id}`, options);
   }
 
+  /**
+   * Retrieves images associated with a specific collection asynchronously.
+   * @param {number} id - The ID of the collection.
+   * @param {CollectionImageOptions} [options] - Optional parameters for specifying image options.
+   * @returns {Promise<ImageCollection>} A Promise that resolves with the collection images.
+   */
   async images(id: number, options?: CollectionImageOptions): Promise<ImageCollection> {
     const computedOptions = {
       include_image_language: options?.include_image_language?.join(','),
@@ -26,6 +45,12 @@ export class CollectionsEndpoint extends BaseEndpoint {
     return await this.api.get<ImageCollection>(`${BASE_COLLECTION}/${id}/images`, computedOptions);
   }
 
+  /**
+   * Retrieves translations for a specific collection asynchronously.
+   * @param {number} id - The ID of the collection.
+   * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+   * @returns {Promise<Translations>} A Promise that resolves with the translations of the collection.
+   */
   async translations(id: number, options?: LanguageOption): Promise<Translations> {
     return await this.api.get<Translations>(`${BASE_COLLECTION}/${id}/translations`, options);
   }

package/src/endpoints/companies.ts

@@ -1,18 +1,40 @@
 import { AlternativeNames, BaseEndpoint, CompanyDetails, CompanyImages } from '@/@types';
 
+/**
+ * Represents an endpoint for accessing company details and related information.
+ */
 export class CompaniesEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new CompaniesEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(protected readonly access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves details of a specific company asynchronously.
+   * @param {number} id - The ID of the company.
+   * @returns {Promise<CompanyDetails>} A Promise that resolves with the detailed information of the company.
+   */
   async details(id: number): Promise<CompanyDetails> {
     return await this.api.get<CompanyDetails>(`/company/${id}`);
   }
 
+  /**
+   * Retrieves alternative names of a specific company asynchronously.
+   * @param {number} id - The ID of the company.
+   * @returns {Promise<AlternativeNames>} A Promise that resolves with the alternative names of the company.
+   */
   async alternativeNames(id: number): Promise<AlternativeNames> {
     return await this.api.get<AlternativeNames>(`/company/${id}/alternative_names`);
   }
 
+  /**
+   * Retrieves images associated with a specific company asynchronously.
+   * @param {number} id - The ID of the company.
+   * @returns {Promise<CompanyImages>} A Promise that resolves with the images of the company.
+   */
   async images(id: number): Promise<CompanyImages> {
     return await this.api.get<CompanyImages>(`/company/${id}/images`);
   }

package/src/endpoints/configuration.ts

@@ -1,10 +1,21 @@
 import { BaseEndpoint, Configuration } from '@/@types';
 
+/**
+ * Represents an endpoint for retrieving current system configuration.
+ */
 export class ConfigurationEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new ConfigurationEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(protected readonly access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves the current system configuration asynchronously.
+   * @returns {Promise<Configuration>} A Promise that resolves with the current system configuration.
+   */
   async getCurrent(): Promise<Configuration> {
     return await this.api.get<Configuration>(`/configuration`);
   }

package/src/endpoints/credits.ts

@@ -1,10 +1,22 @@
 import { BaseEndpoint, CreditResponse } from '@/@types';
 
+/**
+ * Represents an endpoint for retrieving credit details.
+ */
 export class CreditsEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new CreditsEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(protected readonly access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves credit details by ID asynchronously.
+   * @param {string} id - The ID of the credit.
+   * @returns {Promise<CreditResponse>} A Promise that resolves with the credit details.
+   */
   async getById(id: string): Promise<CreditResponse> {
     return await this.api.get<CreditResponse>(`/credit/${id}`);
   }

package/src/endpoints/discover.ts

@@ -1,72 +1,39 @@
-import { BaseEndpoint, MovieDiscoverResult, SortOption, TvShowDiscoverResult } from '@/@types';
+import {
+  BaseEndpoint,
+  MovieDiscoverResult,
+  MovieQueryOptions,
+  TvShowDiscoverResult,
+  TvShowQueryOptions,
+} from '@/@types';
 
 const BASE_DISCOVER = '/discover';
 
-interface DiscoverQueryOptions {
-  language?: string;
-  sort_by?: SortOption;
-  page?: number;
-  'vote_average.gte'?: number;
-  'vote_count.gte'?: number;
-  'vote_count.lte'?: number;
-  'vote_average.lte'?: number;
-  with_watch_providers?: string;
-  watch_region?: string;
-  without_companies?: string;
-  with_watch_monetization_types?: 'flatrate' | 'free' | 'ads' | 'rent' | 'buy';
-  'with_runtime.gte'?: number;
-  'with_runtime.lte'?: number;
-  with_genres?: string;
-  without_genres?: string;
-  with_original_language?: string;
-  without_keywords?: string;
-  with_keywords?: string;
-  with_companies?: string;
-}
-
-interface MovieQueryOptions extends DiscoverQueryOptions {
-  region?: string;
-  certification_country?: string;
-  certification?: string;
-  'certification.lte'?: string;
-  'certification.gte'?: string;
-  include_adult?: boolean;
-  include_video?: boolean;
-  primary_release_year?: number;
-  'primary_release_date.gte'?: string;
-  'primary_release_date.lte'?: string;
-  'release_date.gte'?: string;
-  'release_date.lte'?: string;
-  with_release_type?: string;
-  year?: number;
-  with_cast?: string;
-  with_crew?: string;
-  with_people?: string;
-}
-
-interface TvShowQueryOptions extends DiscoverQueryOptions {
-  'air_date.gte'?: string;
-  'air_date.lte'?: string;
-  'first_air_date.gte'?: string;
-  'first_air_date.lte'?: string;
-  first_air_date_year?: number;
-  timezone?: string;
-  with_networks?: string;
-  include_null_first_air_dates?: boolean;
-  screened_theatrically?: boolean;
-  with_status?: string;
-  with_type?: string;
-}
-
+/**
+ * Represents an endpoint for discovering movies and TV shows based on various criteria.
+ */
 export class DiscoverEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new DiscoverEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves a list of movies based on the provided query options asynchronously.
+   * @param {MovieQueryOptions} [options] - Optional parameters for refining the movie discovery.
+   * @returns {Promise<MovieDiscoverResult>} A Promise that resolves with the movie discovery results.
+   */
   async movie(options?: MovieQueryOptions): Promise<MovieDiscoverResult> {
     return await this.api.get<MovieDiscoverResult>(`${BASE_DISCOVER}/movie`, options);
   }
 
+  /**
+   * Retrieves a list of TV shows based on the provided query options asynchronously.
+   * @param {TvShowQueryOptions} [options] - Optional parameters for refining the TV show discovery.
+   * @returns {Promise<TvShowDiscoverResult>} A Promise that resolves with the TV show discovery results.
+   */
   async tvShow(options?: TvShowQueryOptions): Promise<TvShowDiscoverResult> {
     return await this.api.get<TvShowDiscoverResult>(`${BASE_DISCOVER}/tv`, options);
   }

package/src/endpoints/find.ts

@@ -1,10 +1,23 @@
 import { BaseEndpoint, ExternalIdOptions, FindResult } from '@/@types';
 
+/**
+ * Represents an endpoint for finding media by external ID.
+ */
 export class FindEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new FindEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves media by external ID asynchronously.
+   * @param {string} externalId - The external ID of the media.
+   * @param {ExternalIdOptions} options - Options for finding media by external ID.
+   * @returns {Promise<FindResult>} A Promise that resolves with the result of the find operation.
+   */
   async byId(externalId: string, options: ExternalIdOptions): Promise<FindResult> {
     return await this.api.get<FindResult>(`/find/${externalId}`, options);
   }

package/src/endpoints/genre.ts

@@ -1,18 +1,31 @@
-import { BaseEndpoint, LanguageOption } from '@/@types';
-
-export interface Genres {
-  genres: Array<{ id: number; name: string }>;
-}
+import { BaseEndpoint, Genres, LanguageOption } from '@/@types';
 
+/**
+ * Represents an endpoint for retrieving genre information for movies and TV shows.
+ */
 export class GenreEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new GenreEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(protected readonly access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves genre information for movies asynchronously.
+   * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+   * @returns {Promise<Genres>} A Promise that resolves with the genre information for movies.
+   */
   async movies(options?: LanguageOption): Promise<Genres> {
     return await this.api.get<Genres>('/genre/movie/list', options);
   }
 
+  /**
+   * Retrieves genre information for TV shows asynchronously.
+   * @param {LanguageOption} [options] - Optional parameters for specifying the language.
+   * @returns {Promise<Genres>} A Promise that resolves with the genre information for TV shows.
+   */
   async tv(options?: LanguageOption): Promise<Genres> {
     return await this.api.get<Genres>('/genre/tv/list', options);
   }

package/src/endpoints/keywords.ts

@@ -1,17 +1,35 @@
 import { BaseEndpoint, BelongingMovies, Keyword, KeywordsOptions } from '@/@types';
 
-const BASE_Keyword = '/keyword';
+const BASE_KEYWORD = '/keyword';
 
+/**
+ * Represents an endpoint for accessing keyword details and related movies.
+ */
 export class KeywordsEndpoint extends BaseEndpoint {
+  /**
+   * Constructs a new KeywordsEndpoint instance.
+   * @param {string} access_token - The access token used for authentication.
+   */
   constructor(access_token: string) {
     super(access_token);
   }
 
+  /**
+   * Retrieves details of a specific keyword asynchronously.
+   * @param {number} keywordId - The ID of the keyword.
+   * @returns {Promise<Keyword>} A Promise that resolves with the details of the keyword.
+   */
   async details(keywordId: number): Promise<Keyword> {
-    return await this.api.get<Keyword>(`${BASE_Keyword}/${keywordId}`);
+    return await this.api.get<Keyword>(`${BASE_KEYWORD}/${keywordId}`);
   }
 
+  /**
+   * Retrieves movies belonging to a specific keyword asynchronously.
+   * @param {number} keywordId - The ID of the keyword.
+   * @param {KeywordsOptions} [options] - Optional parameters for refining the search.
+   * @returns {Promise<BelongingMovies>} A Promise that resolves with the movies belonging to the keyword.
+   */
   async belongingMovies(keywordId: number, options?: KeywordsOptions): Promise<BelongingMovies> {
-    return await this.api.get<BelongingMovies>(`${BASE_Keyword}/${keywordId}/movies`, options);
+    return await this.api.get<BelongingMovies>(`${BASE_KEYWORD}/${keywordId}/movies`, options);
   }
 }