@lorenzopant/tmdb 1.6.1 → 1.7.0

package/dist/endpoints/credits.d.ts

@@ -0,0 +1,17 @@
+import { CreditDetails, CreditDetailsParams } from "../types/other/credits";
+import { TMDBAPIBase } from "./base";
+export declare class CreditsAPI extends TMDBAPIBase {
+    private creditPath;
+    /**
+     * Details
+     * GET - https://api.themoviedb.org/3/credit/{credit_id}
+     *
+     * Get the detailed information for a movie or TV credit.
+     *
+     * @param credit_id Unique identifier for the credit
+     * @param language Language for the response
+     * @reference https://developer.themoviedb.org/reference/credit-details
+     */
+    details(params: CreditDetailsParams): Promise<CreditDetails>;
+}
+//# sourceMappingURL=credits.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../src/endpoints/credits.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,qBAAa,UAAW,SAAQ,WAAW;IAC1C,OAAO,CAAC,UAAU;IAIlB;;;;;;;;;OASG;IACG,OAAO,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;CAKlE"}

package/dist/endpoints/credits.js

@@ -0,0 +1,22 @@
+import { ENDPOINTS } from "../routes";
+import { TMDBAPIBase } from "./base";
+export class CreditsAPI extends TMDBAPIBase {
+    creditPath(credit_id) {
+        return `${ENDPOINTS.CREDITS.DETAILS}/${credit_id}`;
+    }
+    /**
+     * Details
+     * GET - https://api.themoviedb.org/3/credit/{credit_id}
+     *
+     * Get the detailed information for a movie or TV credit.
+     *
+     * @param credit_id Unique identifier for the credit
+     * @param language Language for the response
+     * @reference https://developer.themoviedb.org/reference/credit-details
+     */
+    async details(params) {
+        const endpoint = this.creditPath(params.credit_id);
+        const requestParams = this.withLanguage(params) ?? params;
+        return this.client.request(endpoint, requestParams);
+    }
+}

package/dist/routes.d.ts

@@ -16,6 +16,9 @@ export declare const ENDPOINTS: {
         PEOPLE_LIST: string;
         TV_LIST: string;
     };
+    CREDITS: {
+        DETAILS: string;
+    };
     COMPANIES: {
         DETAILS: string;
         ALTERNATIVE_NAMES: 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuFrB,CAAC"}
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0FrB,CAAC"}

package/dist/routes.js

@@ -16,6 +16,9 @@ export const ENDPOINTS = {
         PEOPLE_LIST: "/person/changes",
         TV_LIST: "/tv/changes",
     },
+    CREDITS: {
+        DETAILS: "/credit",
+    },
     COMPANIES: {
         DETAILS: "/company",
         ALTERNATIVE_NAMES: "/alternative_names",

package/dist/tmdb.d.ts

@@ -1,6 +1,7 @@
 import { CertificationsAPI } from "./endpoints/certifications";
 import { ChangesAPI } from "./endpoints/changes";
 import { CompaniesAPI } from "./endpoints/companies";
+import { CreditsAPI } from "./endpoints/credits";
 import { CollectionsAPI } from "./endpoints/collections";
 import { ConfigurationAPI } from "./endpoints/configuration";
 import { GenresAPI } from "./endpoints/genres";
@@ -25,6 +26,7 @@ export declare class TMDB {
     certifications: CertificationsAPI;
     changes: ChangesAPI;
     companies: CompaniesAPI;
+    credits: CreditsAPI;
     collections: CollectionsAPI;
     /**
      * Creates a new TMDB instance.

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,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,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,WAAW,EAAE,cAAc,CAAC;IAGnC;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB;CAiB1D"}
+{"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,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;IAGnC;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB;CAkB1D"}

package/dist/tmdb.js

@@ -3,6 +3,7 @@ import { ApiClient } from "./client";
 import { CertificationsAPI } from "./endpoints/certifications";
 import { ChangesAPI } from "./endpoints/changes";
 import { CompaniesAPI } from "./endpoints/companies";
+import { CreditsAPI } from "./endpoints/credits";
 import { CollectionsAPI } from "./endpoints/collections";
 import { ConfigurationAPI } from "./endpoints/configuration";
 import { GenresAPI } from "./endpoints/genres";
@@ -27,6 +28,7 @@ export class TMDB {
     certifications;
     changes;
     companies;
+    credits;
     collections;
     // etc...
     /**
@@ -50,6 +52,7 @@ export class TMDB {
         this.certifications = new CertificationsAPI(this.client, this.options);
         this.changes = new ChangesAPI(this.client, this.options);
         this.companies = new CompaniesAPI(this.client, this.options);
+        this.credits = new CreditsAPI(this.client, this.options);
         this.collections = new CollectionsAPI(this.client, this.options);
     }
 }

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

@@ -0,0 +1,149 @@
+import { Credit, MediaType, WithLanguage } from "../common";
+import type { LiteralUnion } from "../utility";
+/**
+ * Base params used by all credit queries.
+ */
+export type CreditBaseParam = {
+    /** TMDB credit identifier. */
+    credit_id: string;
+};
+export type CreditDetailsParams = CreditBaseParam & WithLanguage;
+/**
+ * Person data attached to a credit details response.
+ */
+export type CreditDetailsPerson = Omit<Credit, "credit_id">;
+type CreditDetailsMediaBase = {
+    /** Indicates whether the title is marked for adult content. */
+    adult: boolean;
+    /** Relative path to the backdrop image, if available. */
+    backdrop_path?: string | null;
+    /** Character name when the credit belongs to cast. */
+    character?: string;
+    /** Genre identifiers attached to the media item. */
+    genre_ids: number[];
+    /** TMDB media identifier. */
+    id: number;
+    /** Original language code. */
+    original_language: string;
+    /** Plot summary. */
+    overview: string;
+    /** Relative path to the poster image, if available. */
+    poster_path?: string | null;
+    /** Popularity score. */
+    popularity: number;
+    /** Average vote score. */
+    vote_average: number;
+    /** Total vote count. */
+    vote_count: number;
+};
+/**
+ * Movie data attached to a credit details response.
+ */
+export type CreditDetailsMovieMedia = CreditDetailsMediaBase & {
+    /** Media type discriminator. */
+    media_type: "movie";
+    /** Original movie title. */
+    original_title: string;
+    /** Release date in ISO 8601 format. */
+    release_date: string;
+    /** Localized movie title. */
+    title: string;
+    /** Whether the movie has an associated video. */
+    video: boolean;
+};
+/**
+ * TV episode summary embedded in a TV credit details response.
+ */
+export type CreditDetailsTVEpisode = {
+    /** Indicates whether the episode is marked for adult content. */
+    adult: boolean;
+    /** Episode air date in ISO 8601 format, if available. */
+    air_date?: string | null;
+    /** Episode number within the season. */
+    episode_number: number;
+    /** Episode type reported by TMDB. */
+    episode_type: string;
+    /** Unique episode identifier. */
+    id: number;
+    /** Episode title. */
+    name: string;
+    /** Plot summary. */
+    overview: string;
+    /** Production code if available. */
+    production_code: string;
+    /** Runtime in minutes, if available. */
+    runtime?: number | null;
+    /** Season number for the episode. */
+    season_number: number;
+    /** Episode still image path, if available. */
+    still_path?: string | null;
+    /** Average vote score. */
+    vote_average: number;
+    /** Total vote count. */
+    vote_count: number;
+};
+/**
+ * TV season summary embedded in a TV credit details response.
+ */
+export type CreditDetailsTVSeason = {
+    /** Season air date in ISO 8601 format, if available. */
+    air_date?: string | null;
+    /** Total number of episodes in the season. */
+    episode_count: number;
+    /** Unique season identifier. */
+    id: number;
+    /** Season title. */
+    name: string;
+    /** Plot summary. */
+    overview: string;
+    /** Relative path to the season poster, if available. */
+    poster_path?: string | null;
+    /** Season number within the series. */
+    season_number: number;
+    /** Average vote score. */
+    vote_average: number;
+};
+/**
+ * TV series data attached to a credit details response.
+ */
+export type CreditDetailsTVMedia = CreditDetailsMediaBase & {
+    /** TV episodes attached to the specific credit. */
+    episodes: CreditDetailsTVEpisode[];
+    /** First air date in ISO 8601 format. */
+    first_air_date: string;
+    /** Localized series name. */
+    name: string;
+    /** Origin country codes. */
+    origin_country: string[];
+    /** Original series name. */
+    original_name: string;
+    /** Seasons attached to the specific credit. */
+    seasons: CreditDetailsTVSeason[];
+    /** Media type discriminator. */
+    media_type: "tv";
+};
+/**
+ * Media item returned by `/credit/{credit_id}`.
+ */
+export type CreditDetailsMedia = CreditDetailsMovieMedia | CreditDetailsTVMedia;
+/**
+ * Detailed credit information returned by `/credit/{credit_id}`.
+ */
+export type CreditDetails = {
+    /** Cast or crew discriminator returned by TMDB. */
+    credit_type: LiteralUnion<"cast" | "crew">;
+    /** Department associated with the credit. */
+    department: string;
+    /** Unique credit identifier. */
+    id: string;
+    /** Job associated with the credit. */
+    job: string;
+    /** Media type discriminator for the attached media payload. */
+    media_type: MediaType;
+    /** Movie or TV title linked to the credit. */
+    media: CreditDetailsMedia;
+    /** Person linked to the credit. */
+    person: CreditDetailsPerson;
+};
+export {};
+//# sourceMappingURL=credits.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../../src/types/other/credits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,YAAY,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE5D,KAAK,sBAAsB,GAAG;IAC7B,+DAA+D;IAC/D,KAAK,EAAE,OAAO,CAAC;IACf,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,wBAAwB;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,sBAAsB,GAAG;IAC9D,gCAAgC;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,4BAA4B;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,KAAK,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACpC,iEAAiE;IACjE,KAAK,EAAE,OAAO,CAAC;IACf,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,wCAAwC;IACxC,cAAc,EAAE,MAAM,CAAC;IACvB,qCAAqC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,eAAe,EAAE,MAAM,CAAC;IACxB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,qCAAqC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAC;IACtB,gCAAgC;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG;IAC3D,mDAAmD;IACnD,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IACnC,yCAAyC;IACzC,cAAc,EAAE,MAAM,CAAC;IACvB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,4BAA4B;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,gCAAgC;IAChC,UAAU,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,uBAAuB,GAAG,oBAAoB,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,mDAAmD;IACnD,WAAW,EAAE,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAC3C,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,gCAAgC;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,UAAU,EAAE,SAAS,CAAC;IACtB,8CAA8C;IAC9C,KAAK,EAAE,kBAAkB,CAAC;IAC1B,mCAAmC;IACnC,MAAM,EAAE,mBAAmB,CAAC;CAC5B,CAAC"}

package/dist/types/other/credits.js

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

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

@@ -1,3 +1,4 @@
 export * from "./collections";
 export * from "./companies";
+export * from "./credits";
 //# 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"}
+{"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"}

package/dist/types/other/index.js

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

package/package.json

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