@lorenzopant/tmdb 1.8.0 → 1.9.0

package/dist/endpoints/find.d.ts

@@ -0,0 +1,17 @@
+import { FindByIDParams, FindResults } from "../types";
+import { TMDBAPIBase } from "./base";
+export declare class FindAPI extends TMDBAPIBase {
+    /**
+     * By ID
+     * GET - https://api.themoviedb.org/3/find/{external_id}
+     *
+     * Find movies, TV series, seasons, episodes, or people by an external ID.
+     *
+     * @param external_id External identifier to look up
+     * @param external_source Source namespace for the external ID
+     * @param language Language for localized results
+     * @reference https://developer.themoviedb.org/reference/find-by-id
+     */
+    by_id(params: FindByIDParams): Promise<FindResults>;
+}
+//# sourceMappingURL=find.d.ts.map

package/dist/endpoints/find.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../src/endpoints/find.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,qBAAa,OAAQ,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACG,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;CAMzD"}

package/dist/endpoints/find.js

@@ -0,0 +1,21 @@
+import { ENDPOINTS } from "../routes";
+import { TMDBAPIBase } from "./base";
+export class FindAPI extends TMDBAPIBase {
+    /**
+     * By ID
+     * GET - https://api.themoviedb.org/3/find/{external_id}
+     *
+     * Find movies, TV series, seasons, episodes, or people by an external ID.
+     *
+     * @param external_id External identifier to look up
+     * @param external_source Source namespace for the external ID
+     * @param language Language for localized results
+     * @reference https://developer.themoviedb.org/reference/find-by-id
+     */
+    async by_id(params) {
+        const { external_id, ...rest } = params;
+        const endpoint = `${ENDPOINTS.FIND}/${encodeURIComponent(external_id)}`;
+        const requestParams = this.withLanguage(rest);
+        return this.client.request(endpoint, requestParams);
+    }
+}

package/dist/routes.d.ts

@@ -20,6 +20,7 @@ export declare const ENDPOINTS: {
         MOVIE: string;
         TV: string;
     };
+    FIND: string;
     CREDITS: {
         DETAILS: string;
     };

package/dist/routes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8FrB,CAAC"}
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+FrB,CAAC"}

package/dist/routes.js

@@ -20,6 +20,7 @@ export const ENDPOINTS = {
         MOVIE: "/discover/movie",
         TV: "/discover/tv",
     },
+    FIND: "/find",
     CREDITS: {
         DETAILS: "/credit",
     },

package/dist/tmdb.d.ts

@@ -5,6 +5,7 @@ import { CreditsAPI } from "./endpoints/credits";
 import { CollectionsAPI } from "./endpoints/collections";
 import { ConfigurationAPI } from "./endpoints/configuration";
 import { DiscoverAPI } from "./endpoints/discover";
+import { FindAPI } from "./endpoints/find";
 import { GenresAPI } from "./endpoints/genres";
 import { MovieListsAPI } from "./endpoints/movie_lists";
 import { MoviesAPI } from "./endpoints/movies";
@@ -30,6 +31,7 @@ export declare class TMDB {
     credits: CreditsAPI;
     collections: CollectionsAPI;
     discover: DiscoverAPI;
+    find: FindAPI;
     /**
      * Creates a new TMDB instance.
      * @param accessToken The TMDB API access token.

package/dist/tmdb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tmdb.d.ts","sourceRoot":"","sources":["../src/tmdb.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,qBAAa,IAAI;IAChB,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,OAAO,CAAc;IACtB,MAAM,EAAE,SAAS,CAAC;IAClB,WAAW,EAAE,aAAa,CAAC;IAC3B,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,EAAE,QAAQ,CAAC;IACjB,aAAa,EAAE,gBAAgB,CAAC;IAChC,MAAM,EAAE,SAAS,CAAC;IAClB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,WAAW,CAAC;IACvB,cAAc,EAAE,iBAAiB,CAAC;IAClC,OAAO,EAAE,UAAU,CAAC;IACpB,SAAS,EAAE,YAAY,CAAC;IACxB,OAAO,EAAE,UAAU,CAAC;IACpB,WAAW,EAAE,cAAc,CAAC;IAC5B,QAAQ,EAAE,WAAW,CAAC;IAG7B;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB;CAmB1D"}
+{"version":3,"file":"tmdb.d.ts","sourceRoot":"","sources":["../src/tmdb.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,qBAAa,IAAI;IAChB,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,OAAO,CAAc;IACtB,MAAM,EAAE,SAAS,CAAC;IAClB,WAAW,EAAE,aAAa,CAAC;IAC3B,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,EAAE,QAAQ,CAAC;IACjB,aAAa,EAAE,gBAAgB,CAAC;IAChC,MAAM,EAAE,SAAS,CAAC;IAClB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,WAAW,CAAC;IACvB,cAAc,EAAE,iBAAiB,CAAC;IAClC,OAAO,EAAE,UAAU,CAAC;IACpB,SAAS,EAAE,YAAY,CAAC;IACxB,OAAO,EAAE,UAAU,CAAC;IACpB,WAAW,EAAE,cAAc,CAAC;IAC5B,QAAQ,EAAE,WAAW,CAAC;IACtB,IAAI,EAAE,OAAO,CAAC;IAGrB;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB;CAoB1D"}

package/dist/tmdb.js

@@ -7,6 +7,7 @@ import { CreditsAPI } from "./endpoints/credits";
 import { CollectionsAPI } from "./endpoints/collections";
 import { ConfigurationAPI } from "./endpoints/configuration";
 import { DiscoverAPI } from "./endpoints/discover";
+import { FindAPI } from "./endpoints/find";
 import { GenresAPI } from "./endpoints/genres";
 import { MovieListsAPI } from "./endpoints/movie_lists";
 import { MoviesAPI } from "./endpoints/movies";
@@ -32,6 +33,7 @@ export class TMDB {
     credits;
     collections;
     discover;
+    find;
     // etc...
     /**
      * Creates a new TMDB instance.
@@ -57,5 +59,6 @@ export class TMDB {
         this.credits = new CreditsAPI(this.client, this.options);
         this.collections = new CollectionsAPI(this.client, this.options);
         this.discover = new DiscoverAPI(this.client, this.options);
+        this.find = new FindAPI(this.client, this.options);
     }
 }

package/dist/types/other/find.d.ts

@@ -0,0 +1,104 @@
+import { CountryISO3166_1 } from "../config";
+import { Language } from "../config/languages";
+import { LiteralUnion } from "../utility";
+/**
+ * External source values accepted by TMDB's find-by-id endpoint.
+ * @reference https://developer.themoviedb.org/reference/find-by-id
+ */
+export type FindExternalSource = LiteralUnion<"imdb_id" | "tvdb_id" | "freebase_mid" | "freebase_id" | "tvrage_id" | "facebook_id" | "instagram_id" | "twitter_id">;
+/**
+ * Parameters for TMDB's find-by-id endpoint.
+ * `external_id` is sent in the request path and `external_source` as a query param.
+ */
+export type FindByIDParams = {
+    external_id: string;
+    external_source: FindExternalSource;
+    language?: Language;
+};
+type FindMediaResultBase = {
+    adult: boolean;
+    backdrop_path: string | null;
+    id: number;
+    original_language: string;
+    overview: string;
+    poster_path: string | null;
+    popularity: number;
+    vote_average: number;
+    vote_count: number;
+};
+/**
+ * Movie item returned inside `movie_results`.
+ */
+export type FindMovieResultItem = FindMediaResultBase & {
+    media_type: "movie";
+    original_title: string;
+    release_date: string;
+    title: string;
+    video: boolean;
+};
+/**
+ * Person item returned inside `person_results`.
+ */
+export type FindPersonResultItem = {
+    adult: boolean;
+    gender: number | null;
+    id: number;
+    known_for_department: string;
+    media_type: "person";
+    name: string;
+    original_name: string;
+    popularity: number;
+    profile_path: string | null;
+};
+/**
+ * TV series item returned inside `tv_results`.
+ */
+export type FindTVResultItem = FindMediaResultBase & {
+    media_type: "tv";
+    first_air_date: string;
+    name: string;
+    origin_country: CountryISO3166_1[];
+    original_name: string;
+};
+/**
+ * TV episode item returned inside `tv_episode_results`.
+ */
+export type FindTVEpisodeResultItem = {
+    air_date: string;
+    episode_number: number;
+    id: number;
+    media_type: "tv_episode";
+    name: string;
+    overview: string;
+    production_code: string;
+    season_number: number;
+    show_id: number;
+    still_path: string | null;
+    vote_average: number;
+    vote_count: number;
+};
+/**
+ * TV season item returned inside `tv_season_results`.
+ */
+export type FindTVSeasonResultItem = {
+    air_date: string;
+    episode_count: number;
+    id: number;
+    media_type: "tv_season";
+    name: string;
+    overview: string;
+    poster_path: string | null;
+    season_number: number;
+};
+/**
+ * Response returned by TMDB's find-by-id endpoint.
+ */
+export type FindResults = {
+    movie_results: FindMovieResultItem[];
+    person_results: FindPersonResultItem[];
+    tv_results: FindTVResultItem[];
+    tv_episode_results: FindTVEpisodeResultItem[];
+    tv_season_results: FindTVSeasonResultItem[];
+};
+export {};
+//# sourceMappingURL=find.d.ts.map

package/dist/types/other/find.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../src/types/other/find.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAC5C,SAAS,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,YAAY,CACpH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,kBAAkB,CAAC;IACpC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IAC1B,KAAK,EAAE,OAAO,CAAC;IACf,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACvD,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAClC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,EAAE,QAAQ,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG;IACpD,UAAU,EAAE,IAAI,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,gBAAgB,EAAE,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,YAAY,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,WAAW,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,aAAa,EAAE,mBAAmB,EAAE,CAAC;IACrC,cAAc,EAAE,oBAAoB,EAAE,CAAC;IACvC,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;IAC9C,iBAAiB,EAAE,sBAAsB,EAAE,CAAC;CAC5C,CAAC"}

package/dist/types/other/find.js

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

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

@@ -1,4 +1,5 @@
 export * from "./collections";
 export * from "./companies";
 export * from "./credits";
+export * from "./find";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/other/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/other/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/other/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC"}

package/dist/types/other/index.js

@@ -1,3 +1,4 @@
 export * from "./collections";
 export * from "./companies";
 export * from "./credits";
+export * from "./find";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lorenzopant/tmdb",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "A completely type-safe The Movie Database (TMDB) API wrapper for typescript applications.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",