72 Commits

Author SHA1 Message Date
Blake Joynes
4140bd7a7f test license changes 2024-06-09 17:03:27 -04:00
Blake
f513103785 Update npm-publish.yml 2024-06-09 16:59:29 -04:00
Blake
ea19c5b9e1 Merge pull request #56 from blakejoy/feat/2.0
Feat/2.0
2024-06-09 16:57:48 -04:00
Blake Joynes
1bf4063121 update publish script 2024-06-09 16:54:18 -04:00
Blake Joynes
8df7fe2f2a updates types and add watch providers 2024-06-09 15:53:28 -04:00
Blake Joynes
9ac3da7321 update types and add watch providers 2024-06-09 15:52:54 -04:00
Blake Joynes
313d44878c fix format command 2024-06-09 11:27:04 -04:00
Blake Joynes
6fc8c7b6d3 update dependencies 2024-06-09 11:25:34 -04:00
Blake Joynes
730afebd7d update dependencies 2024-06-09 11:25:19 -04:00
Blake
fc44bcf425 Merge pull request #55 from pypp/fix-poster-sizes
Added size w342 to poster sizes
2024-06-09 11:16:31 -04:00
Netanel Henya
defd0a5998 fix:(types/configuration.ts): added w342 size to the poster sizes 2024-04-03 15:17:19 +03:00
Blake
64ba6e0fd1 Merge pull request #54 from blakejoy/fix/const-enums-in-config-type
update const enums in configuration type
2024-03-30 15:50:48 -04:00
Blake Joynes
e723b2f8fa update const enums 2024-03-30 15:49:47 -04:00
Blake
3d3ec34fc5 Merge pull request #52 from blakejoy/bump-1.7.1
Update package.json
2024-03-11 21:05:00 -04:00
Blake
00709c1d28 Update package.json 2024-03-11 21:04:51 -04:00
Blake
9c14fb80fd Merge pull request #51 from blakejoy/v-1.7.0
Update package.json
2024-03-10 14:24:04 -04:00
Blake
c56ecbef47 Update package.json 2024-03-10 14:23:57 -04:00
Blake
876d2cac0f Merge pull request #49 from pypp/feat/undocumented-backdrop-size
Add w500 size to backdrop
2024-03-10 04:10:01 -04:00
Blake
9dae7144b2 Merge pull request #50 from pypp/feat/trending-page-options
Add pageOption to the trending endpoint
2024-03-10 04:09:51 -04:00
Netanel Henya
f99dbac1d2 feat: add pageOption to the trending endpoint 2024-02-23 11:36:05 +02:00
Netanel Henya
43f5d16dc3 feat: added w500 size to backdrop, this size is not in the officel documentation but it still exists 2024-02-23 08:16:29 +02:00
Blake
682cf48cb0 Merge pull request #48 from blakejoy/chore/add-error-res
Feat: Add error response.
2024-01-15 12:02:07 -05:00
Blake Joynes
1146ca8ad2 add error. linting 2024-01-15 11:59:48 -05:00
Blake
6a68e9973b Merge pull request #46 from blakejoy/chore/v1.6
Update package.json
2023-12-28 21:32:30 -05:00
Blake
ad2b27ca72 Update package.json 2023-12-28 21:32:20 -05:00
Blake
76f62210be Merge pull request #42 from jeremyVignelles/fix/39-language-options
[i18n]Fixed all implemented methods that should allow LanguageOptions to be passed
2023-12-28 21:31:20 -05:00
Jérémy VIGNELLES
101457cdd7 Moved interfaces as requested 2023-11-16 14:22:17 +01:00
Jérémy VIGNELLES
7d4b3fcb60 Added languages options for genres 2023-11-16 13:41:45 +01:00
Jérémy VIGNELLES
eb53747570 Fix a bad union type typing 2023-11-16 13:41:44 +01:00
Jérémy VIGNELLES
8c615edbfa Fixed language options on all supported entrypoints 2023-11-16 13:41:35 +01:00
Blake
1628ea05bd Merge pull request #44 from blakejoy/blakejoy-patch-2
Update patch version
2023-11-14 01:13:18 -05:00
Blake
90b70a9c88 Update package.json 2023-11-14 01:13:04 -05:00
Blake
52c874b79f Merge pull request #41 from benlei/master
Adding company data, network data, tv show aggregate credits
2023-11-09 09:44:05 -05:00
Benjamin Lei
31f9cc3fac updating version 2023-09-06 17:19:21 -07:00
Benjamin Lei
d5013db314 adding tv networks 2023-09-01 19:27:15 -07:00
Benjamin Lei
8738ac7fda omit type like rest 2023-09-01 18:53:24 -07:00
Benjamin Lei
152e742883 fixing season aggregate credit type 2023-09-01 18:51:09 -07:00
Benjamin Lei
8c59fe859c format 2023-09-01 18:34:54 -07:00
Benjamin Lei
ab1925d32c adding in aggregate credits 2023-09-01 18:32:37 -07:00
Benjamin Lei
b11187c093 Need to also add in companies getter 2023-08-30 19:43:45 -07:00
Benjamin Lei
f605edf354 applying format 2023-08-30 17:58:37 -07:00
Benjamin Lei
caae3009d5 adding 2023-08-30 17:52:48 -07:00
Benjamin Lei
1c79599c41 Add company endpoints 2023-08-30 17:52:43 -07:00
Blake
d50ec7eb31 Merge pull request #37 from Der-Penz/endpoint/tv-season
Endpoint/tvSeason
2023-05-20 09:02:24 -04:00
DerPenz
f3469510c3 bumbed version : 1.4.0 2023-05-20 12:30:27 +02:00
DerPenz
0020057097 append to response tvSeason support 2023-05-15 13:30:52 +02:00
DerPenz
dbb93f5104 Merge branch 'master' into endpoint/tv-season 2023-05-15 13:13:20 +02:00
Blake
1b8138b971 Merge pull request #35 from Der-Penz/endpoint/tv-episode
Endpoint/tv episode
2023-05-13 16:38:47 -04:00
DerPenz
f6a5375c8c tv seasons endpoint 2023-05-08 17:11:56 +02:00
DerPenz
54cb13c23e bumbed version : 1.3.0 2023-05-06 19:32:14 +02:00
DerPenz
e46f140890 append to response support 2023-05-06 19:29:36 +02:00
DerPenz
33830afe92 refactored change type 2023-05-06 19:22:40 +02:00
DerPenz
9457dce115 base tv-episode integration 2023-05-06 18:57:20 +02:00
Blake
b0b6398169 Merge pull request #33 from xanderbarkhatov/feature/multi-search
Add multi-search, adjust types to allow type narrowing
2023-05-06 10:13:16 -04:00
Alexander B
5d9c61971d Merge branch 'master' of github.com:blakejoy/tmdb-ts into feature/multi-search 2023-05-04 21:38:37 +06:00
Alexander B
16c8b9e4ff chore: bump minor version 2023-05-04 21:35:22 +06:00
Blake
80a5e5e5bd Merge pull request #30 from Der-Penz/feature/append-result
Feature: append_to_result support
2023-05-04 07:49:39 -04:00
DerPenz
4b88e795f1 fixed wrong ImageConfiguration interface 2023-04-30 18:18:57 +02:00
Alexander B
da6427807f feat: add multi-search, adjust types to allow type narrowing 2023-04-28 20:26:34 +06:00
DerPenz
2e6cc38995 Merge branch 'master' into feature/append-result 2023-04-27 11:31:07 +02:00
DerPenz
738a0a7a24 version: 1.1.0 2023-04-27 11:30:34 +02:00
DerPenz
0a7590e989 fixed grammar mistakes 2023-04-27 11:27:12 +02:00
Blake
2705f52160 Merge pull request #32 from blakejoy/blakejoy-patch-1
Update README.md
2023-04-25 22:56:15 -04:00
Blake
2fed644950 Update README.md 2023-04-25 22:56:07 -04:00
DerPenz
bb5e9ad50f fixed bug with undefined second parameter 2023-04-22 15:44:17 +02:00
DerPenz
7d96ad04d1 full support for /person 2023-04-22 15:33:28 +02:00
DerPenz
cf7a561e3f full support for /movie and /tv 2023-04-21 20:59:12 +02:00
Blake
e5ce15d58d Merge pull request #28 from blakejoy/v1
feat: remove default export
2023-04-21 09:15:52 -04:00
DerPenz
cc41646798 append_to_response changes support 2023-04-19 20:23:16 +02:00
DerPenz
5927f95f0a format & combined equal changes type 2023-04-19 20:20:56 +02:00
DerPenz
a5acac981c support for most of the append_to_response options 2023-04-19 20:12:09 +02:00
DerPenz
4f5c39ba7a fixed wrong image type 2023-04-19 19:32:55 +02:00
54 changed files with 2882 additions and 3291 deletions

View File

@@ -1,4 +0,0 @@
node_modules
dist
lib
coverage

View File

@@ -1,22 +0,0 @@
module.exports = {
env: {
browser: false,
es2021: true,
node: true,
},
extends: [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",
"prettier",
],
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: 12,
sourceType: "module",
},
rules:{
'linebreak-style': ['off', 'unix'],
},
plugins: ["@typescript-eslint"],
};

View File

@@ -5,29 +5,29 @@ name: Node.js Package
on: on:
release: release:
types: [created] types: [published]
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: actions/setup-node@v3 - uses: actions/setup-node@v4
with: with:
node-version: 16 node-version: '20.x'
- run: npm ci - run: npm ci
- run: npm test
publish-npm: publish-npm:
needs: build needs: build
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: actions/setup-node@v3 - uses: actions/setup-node@v4
with: with:
node-version: 16 node-version: '20.x'
registry-url: https://registry.npmjs.org/ registry-url: https://registry.npmjs.org/
- run: npm ci - run: npm ci
- run: npm publish - run: npm run compile
- run: npm publish --provenance --access public
env: env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}} NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

2
.nvmrc
View File

@@ -1 +1 @@
v18.16.0 v20.14.0

View File

@@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2021 Blake Joynes Copyright (c) 2024 Blake Joynes
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@@ -14,8 +14,10 @@ Installation:
npm install --save tmdb-ts npm install --save tmdb-ts
`` ``
Version 1.0 removed the default import so make sure you update accordingly!
```js ```js
import TMDB from 'tmdb-ts'; import { TMDB } from 'tmdb-ts';
const tmdb = new TMDB('accessToken'); const tmdb = new TMDB('accessToken');

17
eslint.config.mjs Normal file
View File

@@ -0,0 +1,17 @@
import globals from 'globals';
import pluginJs from '@eslint/js';
import tseslint from 'typescript-eslint';
import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
export default [
{
files: ['src/*.ts'],
ignores: ['node_modules', 'dist', 'lib', 'coverage'],
languageOptions: {
globals: globals.browser,
},
},
pluginJs.configs.recommended,
...tseslint.configs.recommended,
eslintPluginPrettierRecommended,
];

3886
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,16 +1,15 @@
{ {
"name": "tmdb-ts", "name": "tmdb-ts",
"version": "1.0.0", "version": "2.0.0",
"description": "TMDB v3 library wrapper", "description": "TMDB v3 library wrapper",
"main": "dist/index.js", "main": "dist/index.js",
"types": "dist/index.d.ts", "types": "dist/index.d.ts",
"scripts": { "scripts": {
"compile": "rm -rf dist && tsc -d && npm run copy-types", "compile": "rm -rf dist && tsc -d",
"lint": "eslint --ext .ts src/", "lint": "eslint src/",
"lint:fix": "eslint --ext .ts src/ --fix", "lint:fix": "eslint --fix",
"format": "npx prettier --write src", "format": "prettier --write src",
"pre-commit": "npm run lint", "pre-commit": "npm run lint"
"copy-types": "mkdir dist/types && cp src/types/*.d.ts dist/types"
}, },
"bugs": { "bugs": {
"url": "https://github.com/blakejoy/tmdb-ts/issues", "url": "https://github.com/blakejoy/tmdb-ts/issues",
@@ -30,27 +29,22 @@
"author": "Blake Joynes", "author": "Blake Joynes",
"license": "MIT", "license": "MIT",
"devDependencies": { "devDependencies": {
"@types/node": "^18.15.11", "@eslint/js": "^9.4.0",
"@types/node-fetch": "^2.5.10", "@types/eslint__js": "^8.42.3",
"@typescript-eslint/eslint-plugin": "^5.58.0", "@types/node": "^20.14.2",
"@typescript-eslint/parser": "^5.58.0", "@types/node-fetch": "^3.0.3",
"dotenv": "^9.0.2", "dotenv": "^16.4.5",
"eslint": "^8.38.0", "eslint-config-prettier": "^9.1.0",
"eslint-config-airbnb-typescript": "^17.0.0", "eslint-plugin-prettier": "^5.1.3",
"eslint-config-prettier": "^8.8.0", "globals": "^15.4.0",
"eslint-plugin-prettier": "^4.2.1", "husky": "^9.0.11",
"husky": "^8.0.3", "prettier": "^3.3.1",
"prettier": "^2.8.7", "ts-node": "^10.9.2",
"ts-node": "^10.9.1", "typescript": "^5.4.5",
"typescript": "^4.9.5" "typescript-eslint": "^7.12.0"
}, },
"dependencies": { "dependencies": {
"cross-fetch": "^3.1.4" "cross-fetch": "^4.0.0"
},
"volta": {
"node": "18.16.0",
"yarn": "1.22.4",
"npm": "9.5.1"
}, },
"husky": { "husky": {
"hooks": { "hooks": {

View File

@@ -1,13 +1,14 @@
import fetch from 'cross-fetch'; import fetch from 'cross-fetch';
import { parseOptions } from './utils'; import { parseOptions } from './utils';
import { ErrorResponse } from './types';
const BASE_URL_V3 = 'https://api.themoviedb.org/3'; import { BASE_URL_V3 } from './common/constants';
export class Api { export class Api {
constructor(private accessToken: string) { constructor(private accessToken: string) {
this.accessToken = accessToken; this.accessToken = accessToken;
} }
/* eslint-disable @typescript-eslint/no-explicit-any */
async get<T>(path: string, options?: Record<string, any>): Promise<T> { async get<T>(path: string, options?: Record<string, any>): Promise<T> {
const params = parseOptions(options); const params = parseOptions(options);
const response = await fetch(`${BASE_URL_V3}${path}?${params}`, { const response = await fetch(`${BASE_URL_V3}${path}?${params}`, {
@@ -17,6 +18,11 @@ export class Api {
'Content-Type': 'application/json;charset=utf-8', 'Content-Type': 'application/json;charset=utf-8',
}, },
}); });
if (!response.ok) {
return Promise.reject((await response.json()) as ErrorResponse);
}
return (await response.json()) as T; return (await response.json()) as T;
} }
} }

1
src/common/constants.ts Normal file
View File

@@ -0,0 +1 @@
export const BASE_URL_V3 = 'https://api.themoviedb.org/3';

View File

@@ -1,20 +1,20 @@
import { ChangeOption, MediaChanges } from '../types';
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { ChangeOptions, Changes } from '../types/changes';
export class ChangeEndpoint extends BaseEndpoint { export class ChangeEndpoint extends BaseEndpoint {
constructor(protected readonly accessToken: string) { constructor(protected readonly accessToken: string) {
super(accessToken); super(accessToken);
} }
async movies(options?: ChangeOptions): Promise<Changes> { async movies(options?: ChangeOption): Promise<MediaChanges> {
return await this.api.get<Changes>(`/movie/changes`, options); return await this.api.get<MediaChanges>(`/movie/changes`, options);
} }
async tvShows(options?: ChangeOptions): Promise<Changes> { async tvShows(options?: ChangeOption): Promise<MediaChanges> {
return await this.api.get<Changes>(`/tv/changes`, options); return await this.api.get<MediaChanges>(`/tv/changes`, options);
} }
async person(options?: ChangeOptions): Promise<Changes> { async person(options?: ChangeOption): Promise<MediaChanges> {
return await this.api.get<Changes>(`/person/change`, options); return await this.api.get<MediaChanges>(`/person/changes`, options);
} }
} }

View File

@@ -1,5 +1,6 @@
import { import {
DetailedCollection, CollectionDetails,
CollectionImageOptions,
ImageCollection, ImageCollection,
LanguageOption, LanguageOption,
Translations, Translations,
@@ -16,17 +17,24 @@ export class CollectionsEndpoint extends BaseEndpoint {
async details( async details(
id: number, id: number,
options?: LanguageOption options?: LanguageOption
): Promise<DetailedCollection> { ): Promise<CollectionDetails> {
return await this.api.get<DetailedCollection>( return await this.api.get<CollectionDetails>(
`${BASE_COLLECTION}/${id}`, `${BASE_COLLECTION}/${id}`,
options options
); );
} }
async images(id: number, options?: LanguageOption): Promise<ImageCollection> { async images(
id: number,
options?: CollectionImageOptions
): Promise<ImageCollection> {
const computedOptions = {
include_image_language: options?.include_image_language?.join(','),
language: options?.language,
};
return await this.api.get<ImageCollection>( return await this.api.get<ImageCollection>(
`${BASE_COLLECTION}/${id}/images`, `${BASE_COLLECTION}/${id}/images`,
options computedOptions
); );
} }

View File

@@ -0,0 +1,26 @@
import {
CompanyDetails,
AlternativeNames,
CompanyImages,
} from './../types/companies';
import { BaseEndpoint } from './base';
export class CompaniesEndpoint extends BaseEndpoint {
constructor(protected readonly accessToken: string) {
super(accessToken);
}
async details(id: number): Promise<CompanyDetails> {
return await this.api.get<CompanyDetails>(`/company/${id}`);
}
async alternativeNames(id: number): Promise<AlternativeNames> {
return await this.api.get<AlternativeNames>(
`/company/${id}/alternative_names`
);
}
async images(id: number): Promise<CompanyImages> {
return await this.api.get<CompanyImages>(`/company/${id}/images`);
}
}

View File

@@ -1,12 +1,44 @@
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { Configuration } from '../types/configuration'; import {
Configuration,
CountryConfiguration,
JobConfiguration,
LanguageConfiguration,
TimezoneConfiguration,
} from '../types/configuration';
export class ConfigurationEndpoint extends BaseEndpoint { export class ConfigurationEndpoint extends BaseEndpoint {
constructor(protected readonly accessToken: string) { constructor(protected readonly accessToken: string) {
super(accessToken); super(accessToken);
} }
async getCurrent(): Promise<Configuration> { async getApiConfiguration(): Promise<Configuration> {
return await this.api.get<Configuration>(`/configuration`); return await this.api.get<Configuration>(`/configuration`);
} }
async getCountries(): Promise<CountryConfiguration[]> {
return await this.api.get<CountryConfiguration[]>(
`/configuration/countries`
);
}
async getLanguages(): Promise<LanguageConfiguration[]> {
return await this.api.get<LanguageConfiguration[]>(
`/configuration/languages`
);
}
async getJobs(): Promise<JobConfiguration[]> {
return await this.api.get<JobConfiguration[]>(`/configuration/jobs`);
}
async getPrimaryTranslations(): Promise<string[]> {
return await this.api.get<string[]>(`/configuration/primary_translations`);
}
async getTimezones(): Promise<TimezoneConfiguration[]> {
return await this.api.get<TimezoneConfiguration[]>(
`/configuration/timezones`
);
}
} }

View File

@@ -1,68 +1,13 @@
import { import {
MovieDiscoverResult, MovieDiscoverResult,
SortOption, MovieQueryOptions,
TvShowDiscoverResult, TvShowDiscoverResult,
TvShowQueryOptions,
} from '../types'; } from '../types';
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
const BASE_DISCOVER = '/discover'; 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;
}
export class DiscoverEndpoint extends BaseEndpoint { export class DiscoverEndpoint extends BaseEndpoint {
constructor(accessToken: string) { constructor(accessToken: string) {
super(accessToken); super(accessToken);

View File

@@ -6,10 +6,10 @@ export class FindEndpoint extends BaseEndpoint {
super(accessToken); super(accessToken);
} }
async byId( async byExternalId(
externalId: string, id: string,
options: ExternalIdOptions options: ExternalIdOptions
): Promise<FindResult> { ): Promise<FindResult> {
return await this.api.get<FindResult>(`/find/${externalId}`, options); return await this.api.get<FindResult>(`/find/${id}`, options);
} }
} }

View File

@@ -1,3 +1,4 @@
import { LanguageOption } from '../types';
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
export interface Genres { export interface Genres {
@@ -9,11 +10,11 @@ export class GenreEndpoint extends BaseEndpoint {
super(accessToken); super(accessToken);
} }
async movies(): Promise<Genres> { async movies(options?: LanguageOption): Promise<Genres> {
return await this.api.get<Genres>('/genre/movie/list'); return await this.api.get<Genres>('/genre/movie/list', options);
} }
async tvShows(): Promise<Genres> { async tvShows(options?: LanguageOption): Promise<Genres> {
return await this.api.get<Genres>('/genre/tv/list'); return await this.api.get<Genres>('/genre/tv/list', options);
} }
} }

View File

@@ -14,3 +14,6 @@ export * from './trending';
export * from './find'; export * from './find';
export * from './keywords'; export * from './keywords';
export * from './collections'; export * from './collections';
export * from './tv-seasons';
export * from './tv-episode';
export * from './watch-providers';

View File

@@ -12,6 +12,10 @@ export class KeywordsEndpoint extends BaseEndpoint {
return await this.api.get<Keyword>(`${BASE_Keyword}/${keywordId}`); return await this.api.get<Keyword>(`${BASE_Keyword}/${keywordId}`);
} }
/**
*
* @deprecated
*/
async belongingMovies( async belongingMovies(
keywordId: number, keywordId: number,
options?: KeywordsOptions options?: KeywordsOptions

View File

@@ -1,14 +1,17 @@
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { import {
AlternativeTitles, AlternativeTitles,
ChangeOptions, AppendToResponse,
AppendToResponseMovieKey,
ChangeOption,
Changes,
Credits, Credits,
ExternalIds, ExternalIds,
Images, Images,
Keywords, Keywords,
LanguageOption, LanguageOption,
LatestMovie, LatestMovie,
MovieChanges, MovieChangeValue,
MovieDetails, MovieDetails,
MovieLists, MovieLists,
MoviesPlayingNow, MoviesPlayingNow,
@@ -28,13 +31,34 @@ import {
const BASE_MOVIE = '/movie'; const BASE_MOVIE = '/movie';
export interface MoviesImageSearchOptions extends LanguageOption {
/**
* a list of ISO-639-1 values to query
*/
include_image_language?: string[];
}
export class MoviesEndpoint extends BaseEndpoint { export class MoviesEndpoint extends BaseEndpoint {
constructor(protected readonly accessToken: string) { constructor(protected readonly accessToken: string) {
super(accessToken); super(accessToken);
} }
async details(id: number): Promise<MovieDetails> { async details<T extends AppendToResponseMovieKey[] | undefined>(
return await this.api.get<MovieDetails>(`${BASE_MOVIE}/${id}`); id: number,
appendToResponse?: T,
language?: string
) {
const options = {
append_to_response: appendToResponse
? appendToResponse.join(',')
: undefined,
language: language,
};
return await this.api.get<AppendToResponse<MovieDetails, T, 'movie'>>(
`${BASE_MOVIE}/${id}`,
options
);
} }
async alternativeTitles(id: number): Promise<AlternativeTitles> { async alternativeTitles(id: number): Promise<AlternativeTitles> {
@@ -43,23 +67,36 @@ export class MoviesEndpoint extends BaseEndpoint {
); );
} }
async changes(id: number, options?: ChangeOptions): Promise<MovieChanges> { async changes(
return await this.api.get<MovieChanges>( id: number,
options?: ChangeOption
): Promise<Changes<MovieChangeValue>> {
return await this.api.get<Changes<MovieChangeValue>>(
`${BASE_MOVIE}/${id}/changes`, `${BASE_MOVIE}/${id}/changes`,
options options
); );
} }
async credits(id: number): Promise<Credits> { async credits(id: number, options?: LanguageOption): Promise<Credits> {
return await this.api.get<Credits>(`${BASE_MOVIE}/${id}/credits`); return await this.api.get<Credits>(`${BASE_MOVIE}/${id}/credits`, options);
} }
async externalIds(id: number): Promise<ExternalIds> { async externalIds(id: number): Promise<ExternalIds> {
return await this.api.get<ExternalIds>(`${BASE_MOVIE}/${id}/external_ids`); return await this.api.get<ExternalIds>(`${BASE_MOVIE}/${id}/external_ids`);
} }
async images(id: number): Promise<Images> { async images(
return await this.api.get<Images>(`${BASE_MOVIE}/${id}/images`); id: number,
options?: MoviesImageSearchOptions
): Promise<Images> {
const computedOptions = {
include_image_language: options?.include_image_language?.join(','),
language: options?.language,
};
return await this.api.get<Images>(
`${BASE_MOVIE}/${id}/images`,
computedOptions
);
} }
async keywords(id: number): Promise<Keywords> { async keywords(id: number): Promise<Keywords> {
@@ -68,14 +105,14 @@ export class MoviesEndpoint extends BaseEndpoint {
async lists( async lists(
id: number, id: number,
options?: LanguageOption | PageOption options?: LanguageOption & PageOption
): Promise<MovieLists> { ): Promise<MovieLists> {
return await this.api.get<MovieLists>(`${BASE_MOVIE}/${id}/lists`, options); return await this.api.get<MovieLists>(`${BASE_MOVIE}/${id}/lists`, options);
} }
async recommendations( async recommendations(
id: number, id: number,
options?: PageOption options?: LanguageOption & PageOption
): Promise<Recommendations> { ): Promise<Recommendations> {
return await this.api.get<Recommendations>( return await this.api.get<Recommendations>(
`${BASE_MOVIE}/${id}/recommendations`, `${BASE_MOVIE}/${id}/recommendations`,
@@ -89,11 +126,17 @@ export class MoviesEndpoint extends BaseEndpoint {
); );
} }
async reviews(id: number, options?: PageOption): Promise<Reviews> { async reviews(
id: number,
options?: LanguageOption & PageOption
): Promise<Reviews> {
return await this.api.get<Reviews>(`${BASE_MOVIE}/${id}/reviews`, options); return await this.api.get<Reviews>(`${BASE_MOVIE}/${id}/reviews`, options);
} }
async similar(id: number, options?: PageOption): Promise<SimilarMovies> { async similar(
id: number,
options?: LanguageOption & PageOption
): Promise<SimilarMovies> {
return await this.api.get<SimilarMovies>( return await this.api.get<SimilarMovies>(
`${BASE_MOVIE}/${id}/similar`, `${BASE_MOVIE}/${id}/similar`,
options options
@@ -104,8 +147,8 @@ export class MoviesEndpoint extends BaseEndpoint {
return await this.api.get<Translations>(`${BASE_MOVIE}/${id}/translations`); return await this.api.get<Translations>(`${BASE_MOVIE}/${id}/translations`);
} }
async videos(id: number): Promise<Videos> { async videos(id: number, options?: LanguageOption): Promise<Videos> {
return await this.api.get<Videos>(`${BASE_MOVIE}/${id}/videos`); return await this.api.get<Videos>(`${BASE_MOVIE}/${id}/videos`, options);
} }
/** /**
@@ -131,7 +174,7 @@ export class MoviesEndpoint extends BaseEndpoint {
); );
} }
async popular(options?: PageOption): Promise<PopularMovies> { async popular(options?: LanguageOption & PageOption): Promise<PopularMovies> {
return await this.api.get<PopularMovies>(`${BASE_MOVIE}/popular`, options); return await this.api.get<PopularMovies>(`${BASE_MOVIE}/popular`, options);
} }

23
src/endpoints/networks.ts Normal file
View File

@@ -0,0 +1,23 @@
import { NetworkDetails, NetworkImages } from '..';
import { AlternativeNames } from './../types/companies';
import { BaseEndpoint } from './base';
export class NetworksEndpoint extends BaseEndpoint {
constructor(protected readonly accessToken: string) {
super(accessToken);
}
async details(id: number): Promise<NetworkDetails> {
return await this.api.get<NetworkDetails>(`/network/${id}`);
}
async alternativeNames(id: number): Promise<AlternativeNames> {
return await this.api.get<AlternativeNames>(
`/network/${id}/alternative_names`
);
}
async images(id: number): Promise<NetworkImages> {
return await this.api.get<NetworkImages>(`/network/${id}/images`);
}
}

View File

@@ -1,16 +1,20 @@
import { import {
ChangeOptions, AppendToResponse,
AppendToResponsePersonKey,
ChangeOption,
ExternalIds, ExternalIds,
Image,
PageOption, PageOption,
PeopleTranslations, PeopleImages,
PersonChanges, PersonTranslations,
PersonCombinedCredits, PersonCombinedCredits,
PersonDetail, PersonDetails,
PersonMovieCredit, PersonMovieCredit,
PersonTvShowCredit, PersonTvShowCredit,
PopularPersons,
TaggedImages, TaggedImages,
Changes,
PersonChangeValue,
LanguageOption,
PopularPeople,
} from '../types'; } from '../types';
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
@@ -21,32 +25,60 @@ export class PeopleEndpoint extends BaseEndpoint {
super(accessToken); super(accessToken);
} }
async details(id: number): Promise<PersonDetail> { async details<T extends AppendToResponsePersonKey[] | undefined>(
return await this.api.get<PersonDetail>(`${BASE_PERSON}/${id}`); id: number,
appendToResponse?: T,
language?: string
) {
const options = {
append_to_response: appendToResponse
? appendToResponse.join(',')
: undefined,
language: language,
};
return await this.api.get<AppendToResponse<PersonDetails, T, 'person'>>(
`${BASE_PERSON}/${id}`,
options
);
} }
async changes(id: number, options?: ChangeOptions): Promise<PersonChanges> { async changes(
return await this.api.get<PersonChanges>( id: number,
options?: ChangeOption
): Promise<Changes<PersonChangeValue>> {
return await this.api.get<Changes<PersonChangeValue>>(
`${BASE_PERSON}/${id}/changes`, `${BASE_PERSON}/${id}/changes`,
options options
); );
} }
async movieCredits(id: number): Promise<PersonMovieCredit> { async movieCredits(
id: number,
options?: LanguageOption
): Promise<PersonMovieCredit> {
return await this.api.get<PersonMovieCredit>( return await this.api.get<PersonMovieCredit>(
`${BASE_PERSON}/${id}/movie_credits` `${BASE_PERSON}/${id}/movie_credits`,
options
); );
} }
async tvShowCredits(id: number): Promise<PersonTvShowCredit> { async tvShowCredits(
id: number,
options?: LanguageOption
): Promise<PersonTvShowCredit> {
return await this.api.get<PersonTvShowCredit>( return await this.api.get<PersonTvShowCredit>(
`${BASE_PERSON}/${id}/tv_credits` `${BASE_PERSON}/${id}/tv_credits`,
options
); );
} }
async combinedCredits(id: number): Promise<PersonCombinedCredits> { async combinedCredits(
id: number,
options?: LanguageOption
): Promise<PersonCombinedCredits> {
return await this.api.get<PersonCombinedCredits>( return await this.api.get<PersonCombinedCredits>(
`${BASE_PERSON}/${id}/combined_credits` `${BASE_PERSON}/${id}/combined_credits`,
options
); );
} }
@@ -54,12 +86,13 @@ export class PeopleEndpoint extends BaseEndpoint {
return await this.api.get<ExternalIds>(`${BASE_PERSON}/${id}/external_ids`); return await this.api.get<ExternalIds>(`${BASE_PERSON}/${id}/external_ids`);
} }
async images(id: number): Promise<{ id: number; profiles: Image[] }> { async images(id: number): Promise<PeopleImages> {
return await this.api.get<{ id: number; profiles: Image[] }>( return await this.api.get<PeopleImages>(`${BASE_PERSON}/${id}/images`);
`${BASE_PERSON}/${id}/images`
);
} }
/**
* @deprecated
*/
async taggedImages(id: number, options?: PageOption): Promise<TaggedImages> { async taggedImages(id: number, options?: PageOption): Promise<TaggedImages> {
return await this.api.get<TaggedImages>( return await this.api.get<TaggedImages>(
`${BASE_PERSON}/${id}/tagged_images`, `${BASE_PERSON}/${id}/tagged_images`,
@@ -67,20 +100,17 @@ export class PeopleEndpoint extends BaseEndpoint {
); );
} }
async translation(id: number): Promise<PeopleTranslations> { async translation(id: number): Promise<PersonTranslations> {
return await this.api.get<PeopleTranslations>( return await this.api.get<PersonTranslations>(
`${BASE_PERSON}/${id}/translations` `${BASE_PERSON}/${id}/translations`
); );
} }
async latest(): Promise<PersonDetail> { async latest(): Promise<PersonDetails> {
return await this.api.get<PersonDetail>(`${BASE_PERSON}/latest`); return await this.api.get<PersonDetails>(`${BASE_PERSON}/latest`);
} }
async popular(options?: PageOption): Promise<PopularPersons> { async popular(options?: LanguageOption & PageOption): Promise<PopularPeople> {
return await this.api.get<PopularPersons>( return await this.api.get<PopularPeople>(`${BASE_PERSON}/popular`, options);
`${BASE_PERSON}/popular`,
options
);
} }
} }

View File

@@ -1,6 +1,15 @@
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { Search } from '../types/search'; import { MultiSearchResult, Search } from '../types/search';
import { Collection, Company, Movie, Person, TV } from '../types'; import {
Collection,
Company,
LanguageOption,
Movie,
PageOption,
Person,
RegionOption,
TV,
} from '../types';
const BASE_SEARCH = '/search'; const BASE_SEARCH = '/search';
@@ -9,18 +18,44 @@ export interface SearchOptions {
page?: number; page?: number;
} }
export interface MovieSearchOptions extends SearchOptions { export interface MovieSearchOptions
extends SearchOptions,
LanguageOption,
PageOption,
RegionOption {
include_adult?: boolean; include_adult?: boolean;
year?: number; year?: number;
primary_release_year?: number; primary_release_year?: number;
} }
export interface TvSearchOptions extends SearchOptions { export interface CollectionSearchOptions
extends SearchOptions,
LanguageOption,
PageOption,
RegionOption {
include_adult?: boolean; include_adult?: boolean;
}
export interface TvSearchOptions
extends SearchOptions,
LanguageOption,
PageOption {
include_adult?: boolean;
year?: number;
first_air_date_year?: number; first_air_date_year?: number;
} }
export interface PeopleSearchOptions extends SearchOptions { export interface PeopleSearchOptions
extends SearchOptions,
LanguageOption,
PageOption {
include_adult?: boolean;
}
export interface MultiSearchOptions
extends SearchOptions,
LanguageOption,
PageOption {
include_adult?: boolean; include_adult?: boolean;
} }
@@ -60,9 +95,14 @@ export class SearchEndpoint extends BaseEndpoint {
return await this.api.get<Search<Person>>(`${BASE_SEARCH}/person`, options); return await this.api.get<Search<Person>>(`${BASE_SEARCH}/person`, options);
} }
// TODO: Multi search
async tvShows(options: TvSearchOptions): Promise<Search<TV>> { async tvShows(options: TvSearchOptions): Promise<Search<TV>> {
return await this.api.get<Search<TV>>(`${BASE_SEARCH}/tv`, options); return await this.api.get<Search<TV>>(`${BASE_SEARCH}/tv`, options);
} }
async multi(options: MultiSearchOptions): Promise<Search<MultiSearchResult>> {
return await this.api.get<Search<MultiSearchResult>>(
`${BASE_SEARCH}/multi`,
options
);
}
} }

View File

@@ -1,4 +1,10 @@
import { MediaType, TimeWindow, TrendingResults } from '../types'; import {
TrendingMediaType,
TimeWindow,
TrendingResults,
LanguageOption,
PageOption,
} from '../types';
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
export class TrendingEndpoint extends BaseEndpoint { export class TrendingEndpoint extends BaseEndpoint {
@@ -6,12 +12,14 @@ export class TrendingEndpoint extends BaseEndpoint {
super(accessToken); super(accessToken);
} }
async trending<T extends MediaType>( async trending<T extends TrendingMediaType>(
mediaType: T, mediaType: T,
timeWindow: TimeWindow timeWindow: TimeWindow,
options?: LanguageOption & PageOption
): Promise<TrendingResults<T>> { ): Promise<TrendingResults<T>> {
return await this.api.get<TrendingResults<T>>( return await this.api.get<TrendingResults<T>>(
`/trending/${mediaType}/${timeWindow}` `/trending/${mediaType}/${timeWindow}`,
options
); );
} }
} }

111
src/endpoints/tv-episode.ts Normal file
View File

@@ -0,0 +1,111 @@
import {
Episode,
EpisodeSelection,
LanguageOption,
ChangeOption,
TvEpisodeCredit,
ExternalIds,
Images,
TvEpisodeTranslations,
Videos,
AppendToResponse,
Changes,
TvEpisodeChangeValue,
AppendToResponseTvEpisodeKey,
} from '..';
import { BaseEndpoint } from './base';
const BASE_EPISODE = (episodeSelection: EpisodeSelection): string => {
return `/tv/${episodeSelection.tvShowID}/season/${episodeSelection.seasonNumber}/episode/${episodeSelection.episodeNumber}`;
};
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[];
}
export class TvEpisodesEndpoint extends BaseEndpoint {
constructor(accessToken: string) {
super(accessToken);
}
async details<T extends AppendToResponseTvEpisodeKey[] | undefined>(
episodeSelection: EpisodeSelection,
appendToResponse?: T,
options?: LanguageOption
) {
const combinedOptions = {
append_to_response: appendToResponse
? appendToResponse.join(',')
: undefined,
...options,
};
return await this.api.get<
AppendToResponse<Omit<Episode, 'show_id'>, T, 'tvEpisode'>
>(`${BASE_EPISODE(episodeSelection)}`, combinedOptions);
}
async changes(episodeID: number, options?: ChangeOption) {
return await this.api.get<Changes<TvEpisodeChangeValue>>(
`/tv/episode/${episodeID}/changes`,
options
);
}
async credits(episodeSelection: EpisodeSelection, options?: LanguageOption) {
return await this.api.get<TvEpisodeCredit>(
`${BASE_EPISODE(episodeSelection)}/credits`,
options
);
}
async externalIds(episodeSelection: EpisodeSelection) {
return await this.api.get<ExternalIds>(
`${BASE_EPISODE(episodeSelection)}/external_ids`
);
}
async images(
episodeSelection: EpisodeSelection,
options?: TvEpisodeImageSearchOptions
) {
const computedOptions = {
include_image_language: options?.include_image_language?.join(','),
language: options?.language,
};
return await this.api.get<Images>(
`${BASE_EPISODE(episodeSelection)}/images`,
computedOptions
);
}
async translations(episodeSelection: EpisodeSelection) {
return await this.api.get<TvEpisodeTranslations>(
`${BASE_EPISODE(episodeSelection)}/translations`
);
}
async videos(
episodeSelection: EpisodeSelection,
options?: TvEpisodeVideoSearchOptions
) {
const computedOptions = {
include_video_language: options?.include_video_language?.join(','),
language: options?.language,
};
return await this.api.get<Videos>(
`${BASE_EPISODE(episodeSelection)}/videos`,
computedOptions
);
}
}

131
src/endpoints/tv-seasons.ts Normal file
View File

@@ -0,0 +1,131 @@
import {
ChangeOption,
Changes,
Credits,
ExternalIds,
Images,
LanguageOption,
TvSeasonChangeValue,
SeasonDetails,
SeasonSelection,
Translations,
Videos,
AppendToResponseTvSeasonKey,
AppendToResponse,
AggregateCredits,
} from '..';
import { BaseEndpoint } from './base';
const BASE_SEASON = (seasonSelection: SeasonSelection): string => {
return `/tv/${seasonSelection.tvShowID}/season/${seasonSelection.seasonNumber}`;
};
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[];
}
export class TvSeasonsEndpoint extends BaseEndpoint {
constructor(accessToken: string) {
super(accessToken);
}
async details<T extends AppendToResponseTvSeasonKey[] | undefined>(
seasonSelection: SeasonSelection,
appendToResponse?: T,
options?: LanguageOption
) {
const combinedOptions = {
append_to_response: appendToResponse
? appendToResponse.join(',')
: undefined,
...options,
};
return await this.api.get<AppendToResponse<SeasonDetails, T, 'tvSeason'>>(
`${BASE_SEASON(seasonSelection)}`,
combinedOptions
);
}
async aggregateCredits(
seasonSelection: SeasonSelection,
options?: LanguageOption
) {
return await this.api.get<AggregateCredits>(
`${BASE_SEASON(seasonSelection)}/aggregate_credits`,
options
);
}
async changes(seasonId: number, options?: ChangeOption) {
return await this.api.get<Changes<TvSeasonChangeValue>>(
`/tv/season/${seasonId}/changes`,
options
);
}
async credits(seasonSelection: SeasonSelection, options?: LanguageOption) {
return await this.api.get<Credits>(
`${BASE_SEASON(seasonSelection)}/credits`,
options
);
}
async externalIds(
seasonSelection: SeasonSelection,
options?: LanguageOption
) {
return await this.api.get<ExternalIds>(
`${BASE_SEASON(seasonSelection)}/external_ids`,
options
);
}
async images(
seasonSelection: SeasonSelection,
options?: TvSeasonImageSearchOptions
) {
const computedOptions = {
include_image_language: options?.include_image_language?.join(','),
language: options?.language,
};
return await this.api.get<Images>(
`${BASE_SEASON(seasonSelection)}/images`,
computedOptions
);
}
async videos(
seasonSelection: SeasonSelection,
options?: TvSeasonVideoSearchOptions
) {
const computedOptions = {
include_video_language: options?.include_video_language?.join(','),
language: options?.language,
};
return await this.api.get<Videos>(
`${BASE_SEASON(seasonSelection)}/videos`,
computedOptions
);
}
async translations(
seasonSelection: SeasonSelection,
options?: LanguageOption
) {
return await this.api.get<Translations>(
`${BASE_SEASON(seasonSelection)}/translations`,
options
);
}
}

View File

@@ -1,7 +1,11 @@
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { import {
AggregateCredits,
AlternativeTitles, AlternativeTitles,
ChangeOptions, AppendToResponse,
AppendToResponseTvKey,
ChangeOption,
Changes,
ContentRatings, ContentRatings,
Credits, Credits,
EpisodeGroups, EpisodeGroups,
@@ -14,14 +18,16 @@ import {
PageOption, PageOption,
PopularTvShows, PopularTvShows,
Recommendations, Recommendations,
RegionOption,
Reviews, Reviews,
ScreenedTheatrically, ScreenedTheatrically,
SeasonDetails, SeasonDetails,
SimilarTvShows, SimilarTvShows,
TimezoneOption,
TopRatedTvShows, TopRatedTvShows,
Translations, Translations,
TvShowChanges, TvShowImageOptions,
TvShowVideoOptions,
TvShowChangeValue,
TvShowDetails, TvShowDetails,
TvShowsAiringToday, TvShowsAiringToday,
Videos, Videos,
@@ -35,8 +41,21 @@ export class TvShowsEndpoint extends BaseEndpoint {
super(accessToken); super(accessToken);
} }
async details(id: number): Promise<TvShowDetails> { async details<T extends AppendToResponseTvKey[] | undefined>(
return await this.api.get<TvShowDetails>(`${BASE_TV}/${id}`); id: number,
appendToResponse?: T,
language?: string
) {
const options = {
append_to_response: appendToResponse
? appendToResponse.join(',')
: undefined,
language: language,
};
return await this.api.get<AppendToResponse<TvShowDetails, T, 'tvShow'>>(
`${BASE_TV}/${id}`,
options
);
} }
async alternativeTitles(id: number): Promise<AlternativeTitles> { async alternativeTitles(id: number): Promise<AlternativeTitles> {
@@ -45,8 +64,11 @@ export class TvShowsEndpoint extends BaseEndpoint {
); );
} }
async changes(id: number, options?: ChangeOptions): Promise<TvShowChanges> { async changes(
return await this.api.get<TvShowChanges>( id: number,
options?: ChangeOption
): Promise<Changes<TvShowChangeValue>> {
return await this.api.get<Changes<TvShowChangeValue>>(
`${BASE_TV}/${id}/changes`, `${BASE_TV}/${id}/changes`,
options options
); );
@@ -58,8 +80,18 @@ export class TvShowsEndpoint extends BaseEndpoint {
); );
} }
async credits(id: number): Promise<Credits> { async aggregateCredits(
return await this.api.get<Credits>(`${BASE_TV}/${id}/credits`); id: number,
options?: LanguageOption
): Promise<AggregateCredits> {
return await this.api.get<AggregateCredits>(
`${BASE_TV}/${id}/aggregate_credits`,
options
);
}
async credits(id: number, options?: LanguageOption): Promise<Credits> {
return await this.api.get<Credits>(`${BASE_TV}/${id}/credits`, options);
} }
async season(tvId: number, seasonNumber: number): Promise<SeasonDetails> { async season(tvId: number, seasonNumber: number): Promise<SeasonDetails> {
@@ -76,8 +108,15 @@ export class TvShowsEndpoint extends BaseEndpoint {
return await this.api.get<ExternalIds>(`${BASE_TV}/${id}/external_ids`); return await this.api.get<ExternalIds>(`${BASE_TV}/${id}/external_ids`);
} }
async images(id: number): Promise<Images> { async images(id: number, options?: TvShowImageOptions): Promise<Images> {
return await this.api.get<Images>(`${BASE_TV}/${id}/images`); const computedOptions = {
include_image_language: options?.include_image_language?.join(','),
language: options?.language,
};
return await this.api.get<Images>(
`${BASE_TV}/${id}/images`,
computedOptions
);
} }
async keywords(id: number): Promise<Keywords> { async keywords(id: number): Promise<Keywords> {
@@ -86,7 +125,7 @@ export class TvShowsEndpoint extends BaseEndpoint {
async recommendations( async recommendations(
id: number, id: number,
options?: PageOption options?: LanguageOption & PageOption
): Promise<Recommendations> { ): Promise<Recommendations> {
return await this.api.get<Recommendations>( return await this.api.get<Recommendations>(
`${BASE_TV}/${id}/recommendations`, `${BASE_TV}/${id}/recommendations`,
@@ -94,7 +133,10 @@ export class TvShowsEndpoint extends BaseEndpoint {
); );
} }
async reviews(id: number, options?: PageOption): Promise<Reviews> { async reviews(
id: number,
options?: LanguageOption & PageOption
): Promise<Reviews> {
return await this.api.get<Reviews>(`${BASE_TV}/${id}/reviews`, options); return await this.api.get<Reviews>(`${BASE_TV}/${id}/reviews`, options);
} }
@@ -104,7 +146,10 @@ export class TvShowsEndpoint extends BaseEndpoint {
); );
} }
async similar(id: number, options?: PageOption): Promise<SimilarTvShows> { async similar(
id: number,
options?: LanguageOption & PageOption
): Promise<SimilarTvShows> {
return await this.api.get<SimilarTvShows>( return await this.api.get<SimilarTvShows>(
`${BASE_TV}/${id}/similar`, `${BASE_TV}/${id}/similar`,
options options
@@ -115,8 +160,15 @@ export class TvShowsEndpoint extends BaseEndpoint {
return await this.api.get<Translations>(`${BASE_TV}/${id}/translations`); return await this.api.get<Translations>(`${BASE_TV}/${id}/translations`);
} }
async videos(id: number): Promise<Videos> { async videos(id: number, options?: TvShowVideoOptions): Promise<Videos> {
return await this.api.get<Videos>(`${BASE_TV}/${id}/videos`); const computedOptions = {
include_video_language: options?.include_video_language?.join(','),
language: options?.language,
};
return await this.api.get<Videos>(
`${BASE_TV}/${id}/videos`,
computedOptions
);
} }
/** /**
@@ -133,12 +185,14 @@ export class TvShowsEndpoint extends BaseEndpoint {
return await this.api.get<LatestTvShows>(`${BASE_TV}/latest`); return await this.api.get<LatestTvShows>(`${BASE_TV}/latest`);
} }
async onTheAir(): Promise<OnTheAir> { async onTheAir(
return await this.api.get<OnTheAir>(`${BASE_TV}/on_the_air`); options?: PageOption & LanguageOption & TimezoneOption
): Promise<OnTheAir> {
return await this.api.get<OnTheAir>(`${BASE_TV}/on_the_air`, options);
} }
async airingToday( async airingToday(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption & TimezoneOption
): Promise<TvShowsAiringToday> { ): Promise<TvShowsAiringToday> {
return await this.api.get<TvShowsAiringToday>( return await this.api.get<TvShowsAiringToday>(
`${BASE_TV}/airing_today`, `${BASE_TV}/airing_today`,
@@ -147,13 +201,13 @@ export class TvShowsEndpoint extends BaseEndpoint {
} }
async popular( async popular(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption
): Promise<PopularTvShows> { ): Promise<PopularTvShows> {
return await this.api.get<PopularTvShows>(`${BASE_TV}/popular`, options); return await this.api.get<PopularTvShows>(`${BASE_TV}/popular`, options);
} }
async topRated( async topRated(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption
): Promise<TopRatedTvShows> { ): Promise<TopRatedTvShows> {
return await this.api.get<TopRatedTvShows>(`${BASE_TV}/top_rated`, options); return await this.api.get<TopRatedTvShows>(`${BASE_TV}/top_rated`, options);
} }

View File

@@ -0,0 +1,40 @@
import { BaseEndpoint } from './base';
import {
LanguageOption,
RegionResult,
WatchProviderResult,
WatchRegionOption,
} from '../types';
type ProviderOptions = WatchRegionOption & LanguageOption;
export class WatchProvidersEndpoint extends BaseEndpoint {
constructor(protected readonly accessToken: string) {
super(accessToken);
}
async getRegions(options?: LanguageOption): Promise<RegionResult> {
return await this.api.get<RegionResult>(
`/watch/providers/regions`,
options
);
}
async getMovieProviders(
options?: ProviderOptions
): Promise<WatchProviderResult> {
return await this.api.get<WatchProviderResult>(
`/watch/providers/movie`,
options
);
}
async getTvProviders(
options?: ProviderOptions
): Promise<WatchProviderResult> {
return await this.api.get<WatchProviderResult>(
`/watch/providers/tv`,
options
);
}
}

View File

@@ -15,7 +15,12 @@ import {
FindEndpoint, FindEndpoint,
KeywordsEndpoint, KeywordsEndpoint,
CollectionsEndpoint, CollectionsEndpoint,
TvSeasonsEndpoint,
TvEpisodesEndpoint,
WatchProvidersEndpoint,
} from './endpoints'; } from './endpoints';
import { CompaniesEndpoint } from './endpoints/companies';
import { NetworksEndpoint } from './endpoints/networks';
export class TMDB { export class TMDB {
private readonly accessToken: string; private readonly accessToken: string;
@@ -44,6 +49,14 @@ export class TMDB {
return new CreditsEndpoint(this.accessToken); return new CreditsEndpoint(this.accessToken);
} }
get companies(): CompaniesEndpoint {
return new CompaniesEndpoint(this.accessToken);
}
get networks(): NetworksEndpoint {
return new NetworksEndpoint(this.accessToken);
}
get search(): SearchEndpoint { get search(): SearchEndpoint {
return new SearchEndpoint(this.accessToken); return new SearchEndpoint(this.accessToken);
} }
@@ -60,6 +73,10 @@ export class TMDB {
return new TvShowsEndpoint(this.accessToken); return new TvShowsEndpoint(this.accessToken);
} }
get tvEpisode(): TvEpisodesEndpoint {
return new TvEpisodesEndpoint(this.accessToken);
}
get discover(): DiscoverEndpoint { get discover(): DiscoverEndpoint {
return new DiscoverEndpoint(this.accessToken); return new DiscoverEndpoint(this.accessToken);
} }
@@ -87,4 +104,12 @@ export class TMDB {
get collections(): CollectionsEndpoint { get collections(): CollectionsEndpoint {
return new CollectionsEndpoint(this.accessToken); return new CollectionsEndpoint(this.accessToken);
} }
get tvSeasons(): TvSeasonsEndpoint {
return new TvSeasonsEndpoint(this.accessToken);
}
get watchProviders(): WatchProvidersEndpoint {
return new WatchProvidersEndpoint(this.accessToken);
}
} }

View File

@@ -1,3 +1,5 @@
import { CountryCode } from '../types';
export interface Gravatar { export interface Gravatar {
hash: string; hash: string;
} }
@@ -10,7 +12,7 @@ export interface AccountDetails {
avatar: Avatar; avatar: Avatar;
id: number; id: number;
include_adult: boolean; include_adult: boolean;
iso_3166_1: string; iso_3166_1: CountryCode;
iso_639_1: string; iso_639_1: string;
name: string; name: string;
username: string; username: string;

View File

@@ -6,14 +6,56 @@ export interface Certification {
export interface Certifications { export interface Certifications {
certifications: { certifications: {
US: Certification[]; AR: Certification[];
CA: Certification[]; AT: Certification[];
DE: Certification[];
GB: Certification[];
AU: Certification[]; AU: Certification[];
BG: Certification[];
BR: Certification[]; BR: Certification[];
CA: Certification[];
'CA-QC': Certification[];
CH: Certification[];
CL: Certification[];
CZ: Certification[];
DE: Certification[];
DK: Certification[];
ES: Certification[];
FI: Certification[];
FR: Certification[]; FR: Certification[];
NZ: Certification[]; GB: Certification[];
GR: Certification[];
HK: Certification[];
HU: Certification[];
ID: Certification[];
IE: Certification[];
IL: Certification[];
IN: Certification[]; IN: Certification[];
IT: Certification[];
JP: Certification[];
KR: Certification[];
LT: Certification[];
LU: Certification[];
LV: Certification[];
MO: Certification[];
MX: Certification[];
MY: Certification[];
NL: Certification[];
NO: Certification[];
NZ: Certification[];
PH: Certification[];
PL: Certification[];
PR: Certification[];
PT: Certification[];
RO: Certification[];
RU: Certification[];
SE: Certification[];
SG: Certification[];
SK: Certification[];
TH: Certification[];
TR: Certification[];
TW: Certification[];
UA: Certification[];
US: Certification[];
VI: Certification[];
ZA: Certification[];
}; };
} }

View File

@@ -1,17 +1,29 @@
export interface Change { export interface MediaChange {
id: number; id: number;
adult: boolean | undefined; adult?: boolean;
} }
export interface Changes { export interface MediaChanges {
results: Change[]; results: MediaChange[];
page: number; page: number;
total_pages: number; total_pages: number;
total_results: number; total_results: number;
} }
export interface ChangeOptions { export interface Changes<T> {
end_date?: string; changes: Change<T>[];
start_date?: string; }
page?: number;
export interface Change<T> {
key: string;
items: ChangeItem<T>[];
}
export interface ChangeItem<T> {
id: string;
action: string;
time: string;
value: T;
iso_639_1: string;
original_value: T;
} }

View File

@@ -1,16 +1,20 @@
import { Movie } from '.'; import { LanguageOption, Movie } from '.';
export interface Collection { export interface Collection {
id: number; id: number;
backdrop_path: string;
name: string; name: string;
poster_path: string;
adult: boolean;
original_language: string;
original_name: string;
overview: string; overview: string;
poster_path: string;
backdrop_path: string;
} }
export interface DetailedCollection extends Collection { export interface CollectionDetails extends Collection {
parts: Movie[]; parts: Movie[];
} }
export interface CollectionImageOptions extends LanguageOption {
/**
* a list of ISO-639-1 values to query
*/
include_image_language?: string[];
}

33
src/types/companies.ts Normal file
View File

@@ -0,0 +1,33 @@
import { Image } from '.';
export interface CompanyDetails {
description: string;
headquarters: string;
homepage: string;
id: number;
logo_path: string;
name: string;
origin_country: string;
parent_company?: ParentCompany;
}
export interface ParentCompany {
name: string;
id: number;
logo_path: string;
}
export interface AlternativeNames {
id: number;
results: Name[];
}
export interface Name {
name: string;
type: string;
}
export interface CompanyImages {
id: number;
logos: Image[];
}

View File

@@ -1,4 +1,6 @@
export interface Images { import { CountryCode } from '../types';
export interface ImageConfiguration {
base_url: string; base_url: string;
secure_base_url: string; secure_base_url: string;
backdrop_sizes: BackdropSizes[]; backdrop_sizes: BackdropSizes[];
@@ -9,103 +11,157 @@ export interface Images {
} }
export interface Configuration { export interface Configuration {
images: Images; images: ImageConfiguration;
change_keys: ChangeKeys[]; change_keys: ChangeKeys[];
} }
export const enum BackdropSizes { export interface CountryConfiguration {
W300 = 'w300', iso_3166_1: CountryCode;
W780 = 'w780', english_name: string;
W1280 = 'w1280', native_name: string;
ORIGINAL = 'original',
} }
export const enum LogoSizes { export interface LanguageConfiguration {
W45 = 'w45', iso_639_1: string;
W92 = 'w92', english_name: string;
W154 = 'w154', name: string;
W185 = 'w185',
W300 = 'w300',
W500 = 'w500',
ORIGINAL = 'original',
} }
export const enum PosterSizes { export interface JobConfiguration {
W92 = 'w92', department: string;
W154 = 'w154', jobs: string[];
W185 = 'w185',
W300 = 'w300',
W500 = 'w500',
W780 = 'w780',
ORIGINAL = 'original',
} }
export const enum ProfileSizes { export interface TimezoneConfiguration {
W45 = 'w45', iso_3166_1: CountryCode;
W185 = 'w185', zones: string[];
W632 = 'w632',
ORIGINAL = 'original',
} }
export const enum StillSizes { export const MediaSize = {
W92 = 'w92', W45: 'w45',
W185 = 'w185', W92: 'w92',
W300 = 'w300', W154: 'w154',
ORIGINAL = 'original', W185: 'w185',
} W300: 'w300',
W342: 'w342',
W500: 'w500',
W632: 'w632',
W780: 'w780',
W1280: 'w1280',
ORIGINAL: 'original',
} as const;
export const enum ChangeKeys { export const BackdropSize = {
ADULT = 'adult', W45: 'w45',
AIR_DATE = 'air_date', W92: 'w92',
ALSO_KNOWN_AS = 'also_known_as', W154: 'w154',
ALTERNATIVE_TITLES = 'alternative_titles', W185: 'w185',
BIOGRAPHY = 'biography', W300: 'w300',
BIRTHDAY = 'birthday', W500: 'w500',
BUDGET = 'budget', W780: 'w780',
CAST = 'cast', W1280: 'w1280',
CERTIFICATIONS = 'certifications', ORIGINAL: 'original',
CHARACTER_NAMES = 'character_names', } as const;
CREATED_BY = 'created_by',
CREW = 'crew', type BackdropSizes = (typeof BackdropSize)[keyof typeof BackdropSize];
DEATHDAY = 'deathday',
EPISODE = 'episode', export const LogoSize = {
EPISODE_NUMBER = 'episode_number', W45: 'w45',
EPISODE_RUN_TIME = 'episode_run_time', W92: 'w92',
FREEBASE_ID = 'freebase_id', W154: 'w154',
FREEBASE_MID = 'freebase_mid', W185: 'w185',
GENERAL = 'general', W300: 'w300',
GENRES = 'genres', W500: 'w500',
GUEST_STARS = 'guest_stars', ORIGINAL: 'original',
HOMEPAGE = 'homepage', } as const;
IMAGES = 'images',
IMDB_ID = 'imdb_id', type LogoSizes = (typeof LogoSize)[keyof typeof LogoSize];
LANGUAGES = 'languages',
NAME = 'name', export const PosterSize = {
NETWORK = 'network', W92: 'w92',
ORIGIN_COUNTRY = 'origin_country', W154: 'w154',
ORIGINAL_NAME = 'original_name', W185: 'w185',
ORIGINAL_TITLE = 'original_title', W300: 'w300',
OVERVIEW = 'overview', W342: 'w342',
PARTS = 'parts', W500: 'w500',
PLACE_OF_BIRTH = 'place_of_birth', W780: 'w780',
PLOT_KEYWORDS = 'plot_keywords', ORIGINAL: 'original',
PRODUCTION_CODE = 'production_code', } as const;
PRODUCTION_COMPANIES = 'production_companies',
PRODUCTION_COUNTRIES = 'production_countries', type PosterSizes = (typeof PosterSize)[keyof typeof PosterSize];
RELEASES = 'releases',
REVENUE = 'revenue', export const ProfileSize = {
RUNTIME = 'runtime', W45: 'w45',
SEASON = 'season', W185: 'w185',
SEASON_NUMBER = 'season_number', W632: 'w632',
SEASON_REGULAR = 'season_regular', ORIGINAL: 'original',
SPOKEN_LANGUAGES = 'spoken_languages', } as const;
STATUS = 'status',
TAGLINE = 'tagline', type ProfileSizes = (typeof ProfileSize)[keyof typeof ProfileSize];
TITLE = 'title',
TRANSLATIONS = 'translations', export const StillSize = {
TVDB_ID = 'tvdb_id', W92: 'w92',
TVRAGE_ID = 'tvrage_id', W185: 'w185',
TYPE = 'type', W300: 'w300',
VIDEO = 'video', ORIGINAL: 'original',
VIDEOS = 'videos', } as const;
}
type StillSizes = (typeof StillSize)[keyof typeof StillSize];
export const ChangeKey = {
ADULT: 'adult',
AIR_DATE: 'air_date',
ALSO_KNOWN_AS: 'also_known_as',
ALTERNATIVE_TITLES: 'alternative_titles',
BIOGRAPHY: 'biography',
BIRTHDAY: 'birthday',
BUDGET: 'budget',
CAST: 'cast',
CERTIFICATIONS: 'certifications',
CHARACTER_NAMES: 'character_names',
CREATED_BY: 'created_by',
CREW: 'crew',
DEATHDAY: 'deathday',
EPISODE: 'episode',
EPISODE_NUMBER: 'episode_number',
EPISODE_RUN_TIME: 'episode_run_time',
FREEBASE_ID: 'freebase_id',
FREEBASE_MID: 'freebase_mid',
GENERAL: 'general',
GENRES: 'genres',
GUEST_STARS: 'guest_stars',
HOMEPAGE: 'homepage',
IMAGES: 'images',
IMDB_ID: 'imdb_id',
LANGUAGES: 'languages',
NAME: 'name',
NETWORK: 'network',
ORIGIN_COUNTRY: 'origin_country',
ORIGINAL_NAME: 'original_name',
ORIGINAL_TITLE: 'original_title',
OVERVIEW: 'overview',
PARTS: 'parts',
PLACE_OF_BIRTH: 'place_of_birth',
PLOT_KEYWORDS: 'plot_keywords',
PRODUCTION_CODE: 'production_code',
PRODUCTION_COMPANIES: 'production_companies',
PRODUCTION_COUNTRIES: 'production_countries',
RELEASES: 'releases',
REVENUE: 'revenue',
RUNTIME: 'runtime',
SEASON: 'season',
SEASON_NUMBER: 'season_number',
SEASON_REGULAR: 'season_regular',
SPOKEN_LANGUAGES: 'spoken_languages',
STATUS: 'status',
TAGLINE: 'tagline',
TITLE: 'title',
TRANSLATIONS: 'translations',
TVDB_ID: 'tvdb_id',
TVRAGE_ID: 'tvrage_id',
TYPE: 'type',
VIDEO: 'video',
VIDEOS: 'videos',
} as const;
type ChangeKeys = (typeof ChangeKey)[keyof typeof ChangeKey];

View File

@@ -1,4 +1,4 @@
import { Image, Person } from './'; import { CountryCode, Image, Person } from './';
export interface CreditSeason { export interface CreditSeason {
air_date?: string; air_date?: string;
@@ -7,7 +7,7 @@ export interface CreditSeason {
} }
export interface Media { export interface Media {
i?: number; id?: number;
name?: string; name?: string;
first_air_date?: string; first_air_date?: string;
vote_count?: number; vote_count?: number;
@@ -15,6 +15,8 @@ export interface Media {
vote_average?: number; vote_average?: number;
backdrop_path?: string; backdrop_path?: string;
genre_ids?: number[]; genre_ids?: number[];
media_type: string;
adult: boolean;
original_name?: string; original_name?: string;
origin_country?: string[]; origin_country?: string[];
poster_path?: string; poster_path?: string;
@@ -36,7 +38,7 @@ export interface CreditResponse {
} }
export interface Title { export interface Title {
iso_3166_1: string; iso_3166_1: CountryCode;
title: string; title: string;
type: string; type: string;
} }
@@ -89,7 +91,7 @@ export interface ImageCollection {
export interface Video { export interface Video {
id: string; id: string;
iso_639_1: string; iso_639_1: string;
iso_3166_1: string; iso_3166_1: CountryCode;
key: string; key: string;
name: string; name: string;
site: string; site: string;
@@ -101,3 +103,49 @@ export interface Videos {
id: number; id: number;
results: Video[]; results: Video[];
} }
export interface AggregateCredits {
id: number;
cast: AggregateCast[];
crew: AggregateCrew[];
}
export interface CastRole {
credit_id: string;
character: string;
episode_count: number;
}
export interface AggregateCast {
adult: boolean;
gender: number;
id: number;
known_for_department: string;
name: string;
original_name: string;
popularity: number;
profile_path: string;
roles: CastRole[];
total_episode_count: number;
order: number;
}
export interface CrewJob {
credit_id: string;
job: string;
episode_count: number;
}
export interface AggregateCrew {
adult: boolean;
gender: number;
id: number;
known_for_department: string;
name: string;
original_name: string;
popularity: number;
profile_path: string;
jobs: CrewJob[];
department: string;
total_episode_count: number;
}

View File

@@ -1,6 +1,67 @@
import { Movie, TV } from '.'; import { Movie, TV } from '.';
export type MonetizationType = 'flatrate' | 'free' | 'ads' | 'rent' | 'buy';
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?: MonetizationType;
'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;
include_adult?: boolean;
}
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;
}
export type SortOption = export type SortOption =
| 'first_air_date.asc'
| 'first_air_date.desc'
| 'popularity.asc' | 'popularity.asc'
| 'popularity.desc' | 'popularity.desc'
| 'release_date.asc' | 'release_date.asc'

View File

@@ -1,6 +1,8 @@
export * from './options'; export * from './options';
export * from './certification'; export * from './certification';
export * from './credits'; export * from './credits';
export * from './companies';
export * from './networks';
export * from './configuration'; export * from './configuration';
export * from './changes'; export * from './changes';
export * from './movies'; export * from './movies';
@@ -14,6 +16,16 @@ export * from './trending';
export * from './find'; export * from './find';
export * from './keywords'; export * from './keywords';
export * from './collections'; export * from './collections';
export * from './tv-episode';
export * from './tv-seasons';
export interface ErrorResponse {
status_code: number;
status_message: string;
success: boolean;
}
export type MediaType = 'movie' | 'tv' | 'person';
export interface AuthorDetails { export interface AuthorDetails {
name: string; name: string;
@@ -22,27 +34,12 @@ export interface AuthorDetails {
rating?: number; rating?: number;
} }
export interface KnownFor { export type KnownFor = MovieWithMediaType | TVWithMediaType;
id: number;
overview: string;
release_date: string;
video: boolean;
adult: boolean;
backdrop_path: string;
media_type: string;
genre_ids: number[];
title: string;
original_language: string;
original_title: string;
poster_path: string;
vote_count: number;
vote_average: number;
popularity: number;
}
export interface Person { export interface Person {
id: number; id: number;
name: string; name: string;
original_name: string;
known_for: KnownFor[]; known_for: KnownFor[];
profile_path: string; profile_path: string;
adult: boolean; adult: boolean;
@@ -51,6 +48,10 @@ export interface Person {
popularity: number; popularity: number;
} }
export interface PersonWithMediaType extends Person {
media_type: 'person';
}
export interface Movie { export interface Movie {
id: number; id: number;
poster_path: string; poster_path: string;
@@ -68,6 +69,10 @@ export interface Movie {
vote_average: number; vote_average: number;
} }
export interface MovieWithMediaType extends Movie {
media_type: 'movie';
}
export interface Company { export interface Company {
id: number; id: number;
logo_path: string; logo_path: string;
@@ -77,6 +82,7 @@ export interface Company {
export interface TV { export interface TV {
id: number; id: number;
adult: boolean;
name: string; name: string;
first_air_date: string; first_air_date: string;
backdrop_path: string; backdrop_path: string;
@@ -91,6 +97,10 @@ export interface TV {
vote_average: number; vote_average: number;
} }
export interface TVWithMediaType extends TV {
media_type: 'tv';
}
export interface Genre { export interface Genre {
id: number; id: number;
name: string; name: string;
@@ -101,6 +111,13 @@ export interface ExternalIds {
facebook_id: string; facebook_id: string;
instagram_id: string; instagram_id: string;
twitter_id: string; twitter_id: string;
tvdb_id?: number;
freebase_mid?: string;
freebase_id?: string;
tvrage_id?: number;
wikidata_id: string;
tiktok_id?: string;
youtube_id?: string;
id: number; id: number;
} }
@@ -112,7 +129,7 @@ export interface ProductionCompany {
} }
export interface ProductionCountry { export interface ProductionCountry {
iso_3166_1: string; iso_3166_1: CountryCode;
name: string; name: string;
} }
@@ -128,7 +145,8 @@ export interface ContentRatings {
} }
export interface ContentRatingsResult { export interface ContentRatingsResult {
iso_3166_1: string; descriptor: unknown[];
iso_3166_1: CountryCode;
rating: string; rating: string;
} }
@@ -160,9 +178,9 @@ export interface Review {
author: string; author: string;
author_details: AuthorDetails; author_details: AuthorDetails;
content: string; content: string;
created_at: Date; created_at: string;
id: string; id: string;
updated_at: Date; updated_at: string;
url: string; url: string;
} }
@@ -181,7 +199,7 @@ export interface TranslationData {
} }
export interface Translation { export interface Translation {
iso_3166_1: string; iso_3166_1: CountryCode;
iso_639_1: string; iso_639_1: string;
name: string; name: string;
english_name: string; english_name: string;
@@ -202,3 +220,78 @@ export interface Image {
vote_count: number; vote_count: number;
width: number; width: number;
} }
export interface Images {
id: number;
backdrops: Image[];
logos: Image[];
posters: Image[];
}
export const CountryCodes = [
'AE',
'AR',
'AT',
'AU',
'BE',
'BG',
'BO',
'BR',
'CA',
'CH',
'CL',
'CO',
'CR',
'CV',
'CZ',
'DE',
'DK',
'EC',
'EE',
'EG',
'ES',
'FI',
'FR',
'GB',
'GH',
'GR',
'GT',
'HK',
'HN',
'HU',
'ID',
'IE',
'IL',
'IN',
'IT',
'JP',
'LT',
'LV',
'MU',
'MX',
'MY',
'MZ',
'NL',
'NO',
'NZ',
'PE',
'PH',
'PL',
'PT',
'PY',
'RU',
'SA',
'SE',
'SG',
'SI',
'SK',
'TH',
'TR',
'TW',
'UG',
'US',
'VE',
'ZA',
] as const;
export type CountryCode = (typeof CountryCodes)[number];

View File

@@ -1,6 +1,7 @@
import { Movie } from '.'; import { Movie } from '.';
import { PageOption } from './options';
export interface KeywordsOptions { export interface KeywordsOptions extends PageOption {
include_adult?: boolean; include_adult?: boolean;
language?: string; language?: string;
} }

View File

@@ -1,4 +1,5 @@
import { import {
CountryCode,
Genre, Genre,
Movie, Movie,
ProductionCompany, ProductionCompany,
@@ -52,14 +53,15 @@ export enum ReleaseDateType {
export interface ReleaseDate { export interface ReleaseDate {
certification: string; certification: string;
descriptors: string[];
iso_639_1: string; iso_639_1: string;
release_date: Date; release_date: string;
type: ReleaseDateType; type: ReleaseDateType;
note: string; note: string;
} }
export interface ReleaseDateResult { export interface ReleaseDateResult {
iso_3166_1: string; iso_3166_1: CountryCode;
release_dates: ReleaseDate[]; release_dates: ReleaseDate[];
} }
@@ -94,24 +96,6 @@ export interface MovieLists {
total_results: number; total_results: number;
} }
export interface MovieChangeItem {
id: string;
action: string;
time: string;
iso_639_1: string;
value: string;
original_value: string;
}
export interface MovieChange {
key: string;
items: MovieChangeItem[];
}
export interface MovieChanges {
changes: MovieChange[];
}
export interface LatestMovie { export interface LatestMovie {
adult: boolean; adult: boolean;
backdrop_path?: string; backdrop_path?: string;
@@ -173,3 +157,14 @@ export interface UpcomingMovies {
total_results: number; total_results: number;
total_pages: number; total_pages: number;
} }
export type MovieChangeValue =
| string
| {
person_id: number;
character: string;
order: number;
cast_id: number;
credit_id: string;
}
| unknown;

15
src/types/networks.ts Normal file
View File

@@ -0,0 +1,15 @@
import { Image } from '.';
export interface NetworkDetails {
headquarters: string;
homepage: string;
id: number;
logo_path: string;
name: string;
origin_country: string;
}
export interface NetworkImages {
id: number;
logos: Image[];
}

View File

@@ -1,11 +1,389 @@
import {
AlternativeTitles,
Changes,
ContentRatings,
Credits,
EpisodeGroups,
ExternalIds,
Images,
Keywords,
MovieLists,
PeopleImages,
PersonTranslations,
PersonCombinedCredits,
PersonMovieCredit,
PersonTvShowCredit,
Recommendations,
ReleaseDates,
Reviews,
ScreenedTheatrically,
SimilarMovies,
SimilarTvShows,
TaggedImages,
Translations,
Videos,
WatchProviders,
PersonChangeValue,
MovieChangeValue,
TvShowChangeValue,
TvEpisodeChangeValue,
TvEpisodeCredit,
TvEpisodeTranslations,
TvSeasonChangeValue,
CountryCode,
} from '.';
export const AvailableLanguages = [
'af-ZA',
'ar-AE',
'ar-BH',
'ar-EG',
'ar-IQ',
'ar-JO',
'ar-LY',
'ar-MA',
'ar-QA',
'ar-SA',
'ar-TD',
'ar-YE',
'be-BY',
'bg-BG',
'bn-BD',
'br-FR',
'ca-AD',
'ca-ES',
'ch-GU',
'cs-CZ',
'cy-GB',
'da-DK',
'de-AT',
'de-CH',
'de-DE',
'el-CY',
'el-GR',
'en-AG',
'en-AU',
'en-BB',
'en-BZ',
'en-CA',
'en-CM',
'en-GB',
'en-GG',
'en-GH',
'en-GI',
'en-GY',
'en-IE',
'en-JM',
'en-KE',
'en-LC',
'en-MW',
'en-NZ',
'en-PG',
'en-TC',
'en-US',
'en-ZM',
'en-ZW',
'eo-EO',
'es-AR',
'es-CL',
'es-DO',
'es-EC',
'es-ES',
'es-GQ',
'es-GT',
'es-HN',
'es-MX',
'es-NI',
'es-PA',
'es-PE',
'es-PY',
'es-SV',
'es-UY',
'et-EE',
'eu-ES',
'fa-IR',
'fi-FI',
'fr-BF',
'fr-CA',
'fr-CD',
'fr-CI',
'fr-FR',
'fr-GF',
'fr-GP',
'fr-MC',
'fr-ML',
'fr-MU',
'fr-PF',
'ga-IE',
'gd-GB',
'gl-ES',
'he-IL',
'hi-IN',
'hr-HR',
'hu-HU',
'id-ID',
'it-IT',
'it-VA',
'ja-JP',
'ka-GE',
'kk-KZ',
'kn-IN',
'ko-KR',
'ky-KG',
'lt-LT',
'lv-LV',
'ml-IN',
'mr-IN',
'ms-MY',
'ms-SG',
'nb-NO',
'nl-BE',
'nl-NL',
'no-NO',
'pa-IN',
'pl-PL',
'pt-AO',
'pt-BR',
'pt-MZ',
'pt-PT',
'ro-MD',
'ro-RO',
'ru-RU',
'si-LK',
'sk-SK',
'sl-SI',
'sq-AL',
'sq-XK',
'sr-ME',
'sr-RS',
'sv-SE',
'sw-TZ',
'ta-IN',
'te-IN',
'th-TH',
'tl-PH',
'tr-TR',
'uk-UA',
'ur-PK',
'vi-VN',
'zh-CN',
'zh-HK',
'zh-SG',
'zh-TW',
'zu-ZA',
] as const;
export type AvailableLanguage = (typeof AvailableLanguages)[number];
export interface LanguageOption { export interface LanguageOption {
language?: string; language?: AvailableLanguage;
}
export interface WatchRegionOption {
watch_region?: CountryCode;
} }
export interface RegionOption { export interface RegionOption {
region?: string; region?: string;
} }
export interface TimezoneOption {
timezone?: string;
}
export interface PageOption { export interface PageOption {
page?: number; page?: number;
} }
export interface ChangeOption extends PageOption {
start_date?: string;
end_date?: string;
}
export type AppendToResponseMovieKey =
| 'images'
| 'videos'
| 'credits'
| 'recommendations'
| 'reviews'
| 'changes'
| 'similar'
| 'lists'
| 'release_dates'
| 'alternative_titles'
| 'external_ids'
| 'translations'
| 'watch/providers'
| 'keywords';
export type AppendToResponseTvKey =
| 'content_ratings'
| 'images'
| 'videos'
| 'credits'
| 'recommendations'
| 'reviews'
| 'changes'
| 'similar'
| 'alternative_titles'
| 'external_ids'
| 'translations'
| 'watch/providers'
| 'aggregate_credits'
| 'episode_groups'
| 'screened_theatrically'
| 'keywords';
export type AppendToResponsePersonKey =
| 'images'
| 'changes'
| 'movie_credits'
| 'tv_credits'
| 'combined_credits'
| 'external_ids'
| 'tagged_images'
| 'translations';
export type AppendToResponseTvEpisodeKey =
| 'images'
| 'credits'
| 'external_ids'
| 'videos'
| 'translations';
export type AppendToResponseTvSeasonKey =
| 'images'
| 'credits'
| 'external_ids'
| 'videos'
| 'aggregate_credits'
| 'translations';
type AppendToResponseAllKeys =
| AppendToResponseTvKey
| AppendToResponseMovieKey
| AppendToResponseTvEpisodeKey
| AppendToResponseTvSeasonKey
| AppendToResponsePersonKey;
export type AppendToResponseMediaType =
| 'movie'
| 'tvShow'
| 'person'
| 'tvSeason'
| 'tvEpisode';
export type AppendToResponse<
K,
T extends AppendToResponseAllKeys[] | undefined,
Media extends AppendToResponseMediaType,
> = K &
(T extends undefined
? object
: T extends Array<unknown>
? ('credits' extends T[number]
? {
credits: Media extends 'tvEpisode'
? TvEpisodeCredit
: Omit<Credits, 'id'>;
}
: object) &
('videos' extends T[number]
? { videos: Omit<Videos, 'id'> }
: object) &
('images' extends T[number]
? {
images: Omit<
Media extends 'person' ? PeopleImages : Images,
'id'
>;
}
: object) &
('recommendations' extends T[number]
? { recommendations: Recommendations }
: object) &
('reviews' extends T[number]
? { reviews: Omit<Reviews, 'id'> }
: object) &
('reviews' extends T[number]
? { reviews: Omit<Translations, 'id'> }
: object) &
('changes' extends T[number]
? {
changes: Changes<
Media extends 'person'
? PersonChangeValue
: Media extends 'movie'
? MovieChangeValue
: Media extends 'tvShow'
? TvShowChangeValue
: Media extends 'tvSeason'
? TvSeasonChangeValue
: TvEpisodeChangeValue
>;
}
: object) &
('keywords' extends T[number]
? { keywords: Omit<Keywords, 'id'> }
: object) &
('lists' extends T[number]
? { lists: Omit<MovieLists, 'id'> }
: object) &
('release_dates' extends T[number]
? { release_dates: Omit<ReleaseDates, 'id'> }
: object) &
('alternative_titles' extends T[number]
? { alternative_titles: Omit<AlternativeTitles, 'id'> }
: object) &
('external_ids' extends T[number]
? { external_ids: Omit<ExternalIds, 'id'> }
: object) &
('translations' extends T[number]
? {
translations: Omit<
Media extends 'person'
? PersonTranslations
: Media extends 'tvEpisode'
? TvEpisodeTranslations
: Translations,
'id'
>;
}
: object) &
('watch/providers' extends T[number]
? { 'watch/providers': Omit<WatchProviders, 'id'> }
: object) &
('aggregate_credits' extends T[number]
? { aggregate_credits: Omit<Credits, 'id'> }
: object) &
('episode_groups' extends T[number]
? { episode_groups: Omit<EpisodeGroups, 'id'> }
: object) &
('screened_theatrically' extends T[number]
? { screened_theatrically: Omit<ScreenedTheatrically, 'id'> }
: object) &
('similar' extends T[number]
? {
similar: Media extends 'movie'
? SimilarMovies
: Media extends 'tvShow'
? SimilarTvShows
: unknown;
}
: object) &
('content_ratings' extends T[number]
? { content_ratings: Omit<ContentRatings, 'id'> }
: object) &
('movie_credits' extends T[number]
? { movie_credits: Omit<PersonMovieCredit, 'id'> }
: object) &
('tv_credits' extends T[number]
? { tv_credits: Omit<PersonTvShowCredit, 'id'> }
: object) &
('combined_credits' extends T[number]
? { combined_credits: Omit<PersonCombinedCredits, 'id'> }
: object) &
('tagged_images' extends T[number]
? { tagged_images: TaggedImages }
: object)
: never);

View File

@@ -1,4 +1,4 @@
import { Movie, Person, TV } from '.'; import { CountryCode, Image, Movie, Person, TV } from '.';
interface Cast { interface Cast {
character: string; character: string;
@@ -79,7 +79,7 @@ export interface PersonCombinedCredits {
id: number; id: number;
} }
export interface PersonDetail { export interface PersonDetails {
birthday: string; birthday: string;
known_for_department: string; known_for_department: string;
deathday: string; deathday: string;
@@ -96,30 +96,26 @@ export interface PersonDetail {
homepage: string; homepage: string;
} }
export interface PersonChange { export type PersonChangeValue =
id: string; | string
action: string; | {
time: string; profile: {
iso_639_1: string; file_path: string;
iso_3166_1: string; };
value: string | { profile: { file_path: string } }; };
original_value: string | { profile: { file_path: string } };
}
export interface PersonChanges { export interface PopularPeople {
changes: {
key: string;
items: PersonChange[];
}[];
}
export interface PopularPersons {
page: number; page: number;
results: Person[]; results: Person[];
total_results: number; total_results: number;
total_pages: number; total_pages: number;
} }
export interface PeopleImages {
id: number;
profiles: Image[];
}
export interface TaggedImage { export interface TaggedImage {
aspect_ratio: number; aspect_ratio: number;
file_path: string; file_path: string;
@@ -141,10 +137,10 @@ export interface TaggedImages {
total_pages: number; total_pages: number;
} }
export interface PeopleTranslations { export interface PersonTranslations {
id: number; id: number;
translations: { translations: {
iso_3166_1: string; iso_3166_1: CountryCode;
iso_639_1: string; iso_639_1: string;
name: string; name: string;
english_name: string; english_name: string;

7
src/types/regions.ts Normal file
View File

@@ -0,0 +1,7 @@
import { CountryCode } from '../types';
export interface Region {
iso_3166_1: CountryCode;
english_name: string;
native_name: string;
}

View File

@@ -1,6 +1,13 @@
import { MovieWithMediaType, PersonWithMediaType, TVWithMediaType } from '.';
export interface Search<T> { export interface Search<T> {
page: number; page: number;
results: T[]; results: T[];
total_pages: number; total_pages: number;
total_results: number; total_results: number;
} }
export type MultiSearchResult =
| MovieWithMediaType
| TVWithMediaType
| PersonWithMediaType;

View File

@@ -1,19 +1,28 @@
import { Movie, Person, TV } from '.'; import {
export type MediaType = 'all' | 'movie' | 'tv' | 'person'; Movie,
Person,
TV,
MediaType,
MovieWithMediaType,
TVWithMediaType,
PersonWithMediaType,
} from '.';
export type TimeWindow = 'day' | 'week'; export type TimeWindow = 'day' | 'week';
type TrendingResult<T extends MediaType> = T extends 'tv' export type TrendingMediaType = MediaType | 'all';
type TrendingResult<T extends TrendingMediaType> = T extends 'tv'
? TV ? TV
: T extends 'movie' : T extends 'movie'
? Movie ? Movie
: T extends 'person' : T extends 'person'
? Person ? Person
: TV | Movie | Person; : TVWithMediaType | MovieWithMediaType | PersonWithMediaType;
export interface TrendingResults<T extends MediaType> { export interface TrendingResults<T extends TrendingMediaType> {
page: number; page: number;
results: (TrendingResult<T> & { media_type: MediaType })[]; results: TrendingResult<T>[];
total_pages: number; total_pages: number;
total_results: number; total_results: number;
} }

58
src/types/tv-episode.ts Normal file
View File

@@ -0,0 +1,58 @@
import { CountryCode, Credits, Crew } from '.';
export interface EpisodeSelection {
tvShowID: number;
seasonNumber: number;
episodeNumber: number;
}
export interface Episode {
air_date: string;
episode_number: number;
crew: Crew[];
guest_stars: GuestStar[];
id: number;
name: string;
overview: string;
production_code: string;
season_number: number;
still_path: string;
vote_average: number;
vote_count: number;
runtime: number;
show_id: number;
}
export interface GuestStar {
credit_id: string;
order: number;
character: string;
adult: boolean;
gender: number | null;
id: number;
known_for_department: string;
name: string;
original_name: string;
popularity: number;
profile_path: string | null;
}
export interface TvEpisodeCredit extends Credits {
guest_stars: GuestStar[];
}
export interface TvEpisodeTranslations {
id: number;
translations: {
iso_3166_1: CountryCode;
iso_639_1: string;
name: string;
english_name: string;
data: {
name: string;
overview: string;
};
};
}
export type TvEpisodeChangeValue = string | unknown;

23
src/types/tv-seasons.ts Normal file
View File

@@ -0,0 +1,23 @@
import { Episode } from '.';
export interface SeasonSelection {
tvShowID: number;
seasonNumber: number;
}
export interface SeasonDetails {
air_date: string;
episodes: Episode[];
name: string;
overview: string;
id: number;
poster_path: string | null;
season_number: number;
}
export type TvSeasonChangeValue =
| string
| {
episode_id: number;
episode_number: number;
};

View File

@@ -3,7 +3,7 @@ import {
ProductionCompany, ProductionCompany,
ProductionCountry, ProductionCountry,
SpokenLanguage, SpokenLanguage,
Crew, LanguageOption,
} from './'; } from './';
export interface CreatedBy { export interface CreatedBy {
@@ -93,65 +93,6 @@ export interface TvShowDetails {
vote_count: number; vote_count: number;
} }
export interface GuestStar {
credit_id: string;
order: number;
character: string;
adult: boolean;
gender: number | null;
id: number;
known_for_department: string;
name: string;
original_name: string;
popularity: number;
profile_path: string | null;
}
export interface Episode {
air_date: string;
episode_number: number;
crew: Crew[];
guest_stars: GuestStar[];
id: number;
name: string;
overview: string;
production_code: string;
season_number: number;
still_path: string;
vote_average: number;
vote_count: number;
show_id: number;
runtime: number;
}
export interface SeasonDetails {
air_date: string;
episodes: Episode[];
name: string;
overview: string;
id: number;
poster_path: string | null;
season_number: number;
}
export interface TvShowItem {
id: string;
action: string;
time: string;
value: Array<number>;
iso_639_1: string;
original_value: Array<number>;
}
export interface TvShowChange {
key: string;
items: TvShowItem[];
}
export interface TvShowChanges {
changes: TvShowChange[];
}
export interface Network { export interface Network {
id: number; id: number;
logo_path: string; logo_path: string;
@@ -328,3 +269,22 @@ export interface TopRatedTvShows {
total_results: number; total_results: number;
total_pages: number; total_pages: number;
} }
export interface TvShowChangeValue {
season_id: number;
season_number: number;
}
export interface TvShowImageOptions extends LanguageOption {
/**
* a list of ISO-639-1 values to query
*/
include_image_language?: string[];
}
export interface TvShowVideoOptions extends LanguageOption {
/**
* a list of ISO-639-1 values to query
*/
include_video_language?: string[];
}

View File

@@ -1,3 +1,22 @@
import { Region } from './regions';
import { CountryCode } from '../types';
export interface WatchProvider {
display_priorities: { [K in CountryCode]: number };
display_priority: number;
logo_path: string;
provider_id: number;
provider_name: string;
}
export interface RegionResult {
results: Array<Region>;
}
export interface WatchProviderResult {
results: Array<WatchProvider>;
}
export interface Flatrate { export interface Flatrate {
display_priority: number; display_priority: number;
logo_path: string; logo_path: string;

View File

@@ -12,7 +12,7 @@ export const getFullImagePath = (
baseUrl: string, baseUrl: string,
fileSize: string, fileSize: string,
imagePath: string, imagePath: string,
svg = false svg: boolean = false
): string => { ): string => {
const imagePathArr = imagePath.split('.'); const imagePathArr = imagePath.split('.');
const imageFormat = svg ? 'svg' : imagePathArr[1]; const imageFormat = svg ? 'svg' : imagePathArr[1];

View File

@@ -1,4 +1,4 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
export function parseOptions(options?: Record<string, any>): string { export function parseOptions(options?: Record<string, any>): string {
/* eslint-disable @typescript-eslint/no-explicit-any */
return options ? new URLSearchParams(Object.entries(options)).toString() : ''; return options ? new URLSearchParams(Object.entries(options)).toString() : '';
} }

View File

@@ -1,8 +1,8 @@
{ {
"compilerOptions": { "compilerOptions": {
"target": "ES2022" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */, "target": "esnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
"module": "CommonJS" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */, "module": "CommonJS" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
"moduleResolution": "node16", "moduleResolution": "node",
"sourceMap": true /* Generates corresponding '.map' file. */, "sourceMap": true /* Generates corresponding '.map' file. */,
"outDir": "dist" /* Redirect output structure to the directory. */, "outDir": "dist" /* Redirect output structure to the directory. */,
"strict": true /* Enable all strict type-checking options. */, "strict": true /* Enable all strict type-checking options. */,