@lorenzopant/tmdb 1.17.1 → 1.17.2

package/package.json

@@ -1,6 +1,7 @@
 {
 	"name": "@lorenzopant/tmdb",
-	"version": "1.17.1",
+	"version": "1.17.2",
+	"type": "module",
 	"description": "A completely type-safe The Movie Database (TMDB) API wrapper for typescript applications.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -17,8 +18,8 @@
 		"url": "https://github.com/lorenzopant/tmdb/issues"
 	},
 	"scripts": {
-		"build": "rm -rf dist && tsc",
-		"dev": "tsc --watch",
+		"build": "tsup",
+		"dev": "tsup --watch",
 		"typecheck": "tsc --noEmit",
 		"test": "vitest",
 		"test:unit": "vitest run --exclude '**/*.integration.test.ts'",
@@ -58,20 +59,26 @@
 		"release-it": "^19.0.3",
 		"release-it-pnpm": "^4.6.6",
 		"ts-morph": "^27.0.2",
+		"tsup": "^8.5.1",
 		"tsx": "^4.21.0",
 		"typescript": "^5.8.3",
 		"typescript-eslint": "^8.35.0",
 		"vite": "^7.0.0",
 		"vitest": "^4.0.9"
 	},
+	"pnpm": {
+		"overrides": {
+			"basic-ftp": "5.2.0"
+		}
+	},
 	"exports": {
 		".": {
 			"import": "./dist/index.js",
 			"types": "./dist/index.d.ts"
 		},
 		"./types": {
-			"types": "./dist/types/index.d.ts",
-			"default": "./dist/types/index.js"
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
 		}
 	}
 }

package/dist/client.d.ts

@@ -1,51 +0,0 @@
-import { TMDBLoggerFn } from "./utils/logger";
-export declare class ApiClient {
-    private accessToken;
-    private baseUrl;
-    private logger?;
-    /**
-     * Tracks in-flight requests keyed by a deterministic string derived from the endpoint
-     * and its parameters. When two identical requests are fired concurrently, the second
-     * caller receives the same Promise as the first — only one fetch is made.
-     * Entries are removed via `.finally()` so the map never holds settled promises.
-     */
-    private inflightRequests;
-    private deduplication;
-    constructor(accessToken: string, options?: {
-        logger?: boolean | TMDBLoggerFn;
-        deduplication?: boolean;
-    });
-    /**
-     * Builds a stable, order-independent cache key for a request.
-     *
-     * `undefined` values are excluded (they are never serialised into the URL),
-     * and the remaining entries are sorted alphabetically before joining so that
-     * `{ language, page }` and `{ page, language }` produce the same key.
-     */
-    private buildRequestKey;
-    /**
-     * Makes an authenticated GET request to the TMDB API, returning the parsed and
-     * null-sanitised response.
-     *
-     * **Deduplication:** when enabled (the default), concurrent calls with the same
-     * `endpoint` + `params` share a single in-flight fetch. The second (and any
-     * subsequent) caller receives the same `Promise` — no extra network request is made.
-     * Once the promise settles (success or error) it is evicted from the map so the next
-     * call triggers a fresh fetch. Deduplication can be disabled globally via
-     * `TMDBOptions.deduplication = false`.
-     */
-    request<T>(endpoint: string, params?: Record<string, unknown | undefined>): Promise<T>;
-    /**
-     * The actual fetch + response-parsing pipeline. Called by `request()` only when no
-     * matching in-flight promise exists. Handles URL construction, auth headers, logging,
-     * error mapping, and null sanitisation.
-     */
-    private doRequest;
-    /**
-     * Recursively converts null values to undefined in API responses.
-     * This allows optional properties to model fields that TMDB returns as nullable.
-     * Response types for nullable fields should account for possible undefined values.
-     */
-    private sanitizeNulls;
-    private handleError;
-}

package/dist/client.js

@@ -1,166 +0,0 @@
-import { TMDBError } from "./errors/tmdb";
-import { TMDBLogger } from "./utils/logger";
-import { isJwt } from "./utils";
-export class ApiClient {
-    accessToken;
-    baseUrl = "https://api.themoviedb.org/3";
-    logger;
-    /**
-     * Tracks in-flight requests keyed by a deterministic string derived from the endpoint
-     * and its parameters. When two identical requests are fired concurrently, the second
-     * caller receives the same Promise as the first — only one fetch is made.
-     * Entries are removed via `.finally()` so the map never holds settled promises.
-     */
-    inflightRequests = new Map();
-    deduplication;
-    constructor(accessToken, options = {}) {
-        this.accessToken = accessToken;
-        this.logger = TMDBLogger.from(options.logger);
-        this.deduplication = options.deduplication !== false;
-    }
-    /**
-     * Builds a stable, order-independent cache key for a request.
-     *
-     * `undefined` values are excluded (they are never serialised into the URL),
-     * and the remaining entries are sorted alphabetically before joining so that
-     * `{ language, page }` and `{ page, language }` produce the same key.
-     */
-    buildRequestKey(endpoint, params) {
-        const definedEntries = Object.entries(params)
-            .filter(([, v]) => v !== undefined)
-            .sort(([a], [b]) => a.localeCompare(b))
-            .map(([k, v]) => `${k}=${String(v)}`);
-        return definedEntries.length > 0 ? `${endpoint}?${definedEntries.join("&")}` : endpoint;
-    }
-    /**
-     * Makes an authenticated GET request to the TMDB API, returning the parsed and
-     * null-sanitised response.
-     *
-     * **Deduplication:** when enabled (the default), concurrent calls with the same
-     * `endpoint` + `params` share a single in-flight fetch. The second (and any
-     * subsequent) caller receives the same `Promise` — no extra network request is made.
-     * Once the promise settles (success or error) it is evicted from the map so the next
-     * call triggers a fresh fetch. Deduplication can be disabled globally via
-     * `TMDBOptions.deduplication = false`.
-     */
-    async request(endpoint, params = {}) {
-        if (!this.deduplication)
-            return this.doRequest(endpoint, params);
-        const key = this.buildRequestKey(endpoint, params);
-        const existing = this.inflightRequests.get(key);
-        if (existing)
-            return existing;
-        const promise = this.doRequest(endpoint, params).finally(() => {
-            this.inflightRequests.delete(key);
-        });
-        this.inflightRequests.set(key, promise);
-        return promise;
-    }
-    /**
-     * The actual fetch + response-parsing pipeline. Called by `request()` only when no
-     * matching in-flight promise exists. Handles URL construction, auth headers, logging,
-     * error mapping, and null sanitisation.
-     */
-    async doRequest(endpoint, params) {
-        const url = new URL(`${this.baseUrl}${endpoint}`);
-        const jwt = isJwt(this.accessToken);
-        for (const [key, value] of Object.entries(params)) {
-            if (value === undefined)
-                continue;
-            url.searchParams.append(key, String(value));
-        }
-        if (!jwt) {
-            url.searchParams.append("api_key", this.accessToken);
-        }
-        const startedAt = Date.now();
-        this.logger?.log({
-            type: "request",
-            method: "GET",
-            endpoint,
-        });
-        let res;
-        try {
-            res = await fetch(url.toString(), {
-                headers: jwt
-                    ? {
-                        Authorization: `Bearer ${this.accessToken}`,
-                        "Content-Type": "application/json;charset=utf-8",
-                    }
-                    : {
-                        "Content-Type": "application/json;charset=utf-8",
-                    },
-            });
-        }
-        catch (error) {
-            this.logger?.log({
-                type: "error",
-                method: "GET",
-                endpoint,
-                errorMessage: error instanceof Error ? error.message : String(error),
-                durationMs: Date.now() - startedAt,
-            });
-            throw error;
-        }
-        if (!res.ok)
-            await this.handleError(res, endpoint);
-        this.logger?.log({
-            type: "response",
-            method: "GET",
-            endpoint,
-            status: res.status,
-            statusText: res.statusText,
-            durationMs: Date.now() - startedAt,
-        });
-        const data = await res.json();
-        return this.sanitizeNulls(data);
-    }
-    /**
-     * Recursively converts null values to undefined in API responses.
-     * This allows optional properties to model fields that TMDB returns as nullable.
-     * Response types for nullable fields should account for possible undefined values.
-     */
-    sanitizeNulls(value) {
-        // Only convert null to undefined, keep undefined as-is
-        if (value === null) {
-            return undefined;
-        }
-        if (typeof value !== "object") {
-            return value;
-        }
-        if (Array.isArray(value)) {
-            return value.map((v) => this.sanitizeNulls(v));
-        }
-        const sanitized = {};
-        for (const [key, val] of Object.entries(value)) {
-            sanitized[key] = this.sanitizeNulls(val);
-        }
-        return sanitized;
-    }
-    async handleError(res, endpoint) {
-        let errorMessage = res.statusText;
-        let tmdbStatusCode = -1;
-        try {
-            const errorBody = await res.json();
-            if (errorBody && typeof errorBody === "object") {
-                const err = errorBody;
-                errorMessage = err.status_message || errorMessage;
-                tmdbStatusCode = err.status_code || -1;
-            }
-        }
-        catch (error) {
-            console.error(`Unknown error: ${error}`);
-            // If response is not JSON, fallback to HTTP status text
-        }
-        this.logger?.log({
-            type: "error",
-            method: "GET",
-            endpoint,
-            status: res.status,
-            statusText: res.statusText,
-            tmdbStatusCode,
-            errorMessage,
-        });
-        const error = new TMDBError(errorMessage, res.status, tmdbStatusCode);
-        throw error;
-    }
-}

package/dist/endpoints/base.d.ts

@@ -1,22 +0,0 @@
-import { ApiClient } from "../client";
-import { Language } from "../types";
-import { TMDBOptions } from "../types/config";
-export declare abstract class TMDBAPIBase {
-    protected client: ApiClient;
-    protected defaultOptions: TMDBOptions;
-    constructor(client: ApiClient, defaultOptions?: TMDBOptions);
-    /**
-     * Merges the endpoint's params with TMDB-wide defaults (language, region).
-     * Works only for param types that include optional `language` and `region` fields.
-     * Only request-safe defaults are merged — config-only options (logger, images, etc.) are excluded.
-     */
-    protected applyDefaults<T extends object>(params?: T): T | undefined;
-    /**
-     * Ensures params contains a language: prefer explicit param, fallback to defaultOptions.language.
-     * If neither is present, returns the original params unmodified.
-     * When params is undefined but a default language is set, returns { language: defaultLang }.
-     */
-    protected withLanguage<T extends {
-        language?: Language;
-    }>(params?: T): T | undefined;
-}

package/dist/endpoints/base.js

@@ -1,32 +0,0 @@
-export class TMDBAPIBase {
-    client;
-    defaultOptions;
-    constructor(client, defaultOptions = {}) {
-        this.client = client;
-        this.defaultOptions = defaultOptions;
-    }
-    /**
-     * Merges the endpoint's params with TMDB-wide defaults (language, region).
-     * Works only for param types that include optional `language` and `region` fields.
-     * Only request-safe defaults are merged — config-only options (logger, images, etc.) are excluded.
-     */
-    applyDefaults(params) {
-        const { language, region } = this.defaultOptions;
-        return { ...(language !== undefined && { language }), ...(region !== undefined && { region }), ...params };
-    }
-    /**
-     * Ensures params contains a language: prefer explicit param, fallback to defaultOptions.language.
-     * If neither is present, returns the original params unmodified.
-     * When params is undefined but a default language is set, returns { language: defaultLang }.
-     */
-    withLanguage(params) {
-        const defaultLang = this.defaultOptions?.language;
-        if (!params)
-            return defaultLang !== undefined ? { language: defaultLang } : undefined;
-        if (params.language !== undefined)
-            return params;
-        if (defaultLang === undefined)
-            return params;
-        return { ...params, language: defaultLang };
-    }
-}

package/dist/endpoints/certifications.d.ts

@@ -1,20 +0,0 @@
-import { Certifications } from "../types";
-import { TMDBAPIBase } from "./base";
-export declare class CertificationsAPI extends TMDBAPIBase {
-    /**
-     * Movie Certifications
-     * GET - https://api.themoviedb.org/3/certification/movie/list
-     *
-     * Get an up to date list of the officially supported movie certifications on TMDB.
-     * @reference https://developer.themoviedb.org/reference/certification-movie-list
-     */
-    movie_certifications(): Promise<Certifications>;
-    /**
-     * TV Certifications
-     * GET - https://api.themoviedb.org/3/certification/tv/list
-     *
-     * Get an up to date list of the officially supported tv certifications on TMDB.
-     * @reference https://developer.themoviedb.org/reference/certification-tv-list
-     */
-    tv_certifications(): Promise<Certifications>;
-}

package/dist/endpoints/certifications.js

@@ -1,24 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class CertificationsAPI extends TMDBAPIBase {
-    /**
-     * Movie Certifications
-     * GET - https://api.themoviedb.org/3/certification/movie/list
-     *
-     * Get an up to date list of the officially supported movie certifications on TMDB.
-     * @reference https://developer.themoviedb.org/reference/certification-movie-list
-     */
-    async movie_certifications() {
-        return this.client.request(ENDPOINTS.CERTIFICATIONS.MOVIE_CERTIFICATIONS);
-    }
-    /**
-     * TV Certifications
-     * GET - https://api.themoviedb.org/3/certification/tv/list
-     *
-     * Get an up to date list of the officially supported tv certifications on TMDB.
-     * @reference https://developer.themoviedb.org/reference/certification-tv-list
-     */
-    async tv_certifications() {
-        return this.client.request(ENDPOINTS.CERTIFICATIONS.TV_CERTIFICATIONS);
-    }
-}

package/dist/endpoints/changes.d.ts

@@ -1,40 +0,0 @@
-import { ChangeResultItem, PaginatedResponse, WithPageAndDateRange } from "../types";
-import { TMDBAPIBase } from "./base";
-export declare class ChangesAPI extends TMDBAPIBase {
-    /**
-     * Movie List
-     * GET - https://api.themoviedb.org/3/movie/changes
-     *
-     * Get a list of all of the movie ids that have been changed in the past 24 hours.
-     *
-     * @param page Page number
-     * @param start_date Start date for change items
-     * @param end_date End date for change items
-     * @reference https://developer.themoviedb.org/reference/changes-movie-list
-     */
-    movie_list(params?: WithPageAndDateRange): Promise<PaginatedResponse<ChangeResultItem>>;
-    /**
-     * People List
-     * GET - https://api.themoviedb.org/3/person/changes
-     *
-     * Get a list of all of the person ids that have been changed in the past 24 hours.
-     *
-     * @param page Page number
-     * @param start_date Start date for change items
-     * @param end_date End date for change items
-     * @reference https://developer.themoviedb.org/reference/changes-people-list
-     */
-    people_list(params?: WithPageAndDateRange): Promise<PaginatedResponse<ChangeResultItem>>;
-    /**
-     * TV List
-     * GET - https://api.themoviedb.org/3/tv/changes
-     *
-     * Get a list of all of the tv show ids that have been changed in the past 24 hours.
-     *
-     * @param page Page number
-     * @param start_date Start date for change items
-     * @param end_date End date for change items
-     * @reference https://developer.themoviedb.org/reference/changes-tv-list
-     */
-    tv_list(params?: WithPageAndDateRange): Promise<PaginatedResponse<ChangeResultItem>>;
-}

package/dist/endpoints/changes.js

@@ -1,46 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class ChangesAPI extends TMDBAPIBase {
-    /**
-     * Movie List
-     * GET - https://api.themoviedb.org/3/movie/changes
-     *
-     * Get a list of all of the movie ids that have been changed in the past 24 hours.
-     *
-     * @param page Page number
-     * @param start_date Start date for change items
-     * @param end_date End date for change items
-     * @reference https://developer.themoviedb.org/reference/changes-movie-list
-     */
-    async movie_list(params) {
-        return this.client.request(ENDPOINTS.CHANGES.MOVIE_LIST, params);
-    }
-    /**
-     * People List
-     * GET - https://api.themoviedb.org/3/person/changes
-     *
-     * Get a list of all of the person ids that have been changed in the past 24 hours.
-     *
-     * @param page Page number
-     * @param start_date Start date for change items
-     * @param end_date End date for change items
-     * @reference https://developer.themoviedb.org/reference/changes-people-list
-     */
-    async people_list(params) {
-        return this.client.request(ENDPOINTS.CHANGES.PEOPLE_LIST, params);
-    }
-    /**
-     * TV List
-     * GET - https://api.themoviedb.org/3/tv/changes
-     *
-     * Get a list of all of the tv show ids that have been changed in the past 24 hours.
-     *
-     * @param page Page number
-     * @param start_date Start date for change items
-     * @param end_date End date for change items
-     * @reference https://developer.themoviedb.org/reference/changes-tv-list
-     */
-    async tv_list(params) {
-        return this.client.request(ENDPOINTS.CHANGES.TV_LIST, params);
-    }
-}

package/dist/endpoints/collections.d.ts

@@ -1,39 +0,0 @@
-import { CollectionBaseParam, Collection, CollectionDetailsParams, CollectionImages, CollectionImagesParams, CollectionTranslations } from "../types/collections";
-import { TMDBAPIBase } from "./base";
-export declare class CollectionsAPI extends TMDBAPIBase {
-    private collectionPath;
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/collection/{collection_id}
-     *
-     * Get collection details by ID.
-     *
-     * @param collection_id Unique identifier for the collection
-     * @param language Language for the response
-     * @reference https://developer.themoviedb.org/reference/collection-details
-     */
-    details(params: CollectionDetailsParams): Promise<Collection>;
-    /**
-     * Images
-     * GET - https://api.themoviedb.org/3/collection/{collection_id}/images
-     *
-     * Get the images that belong to a collection.
-     * This method will return the backdrops and posters that have been added to a collection.
-     *
-     * @param collection_id Unique identifier for the collection
-     * @param language Language for the response
-     * @param include_image_language Additional language for images
-     * @reference https://developer.themoviedb.org/reference/collection-images
-     */
-    images(params: CollectionImagesParams): Promise<CollectionImages>;
-    /**
-     * Translations
-     * GET - https://api.themoviedb.org/3/collection/{collection_id}/translations
-     *
-     * Get collection translations by ID.
-     *
-     * @param collection_id Unique identifier for the collection
-     * @reference https://developer.themoviedb.org/reference/collection-translations
-     */
-    translations(params: CollectionBaseParam): Promise<CollectionTranslations>;
-}

package/dist/endpoints/collections.js

@@ -1,52 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class CollectionsAPI extends TMDBAPIBase {
-    collectionPath(collection_id) {
-        return `${ENDPOINTS.COLLECTIONS.DETAILS}/${collection_id}`;
-    }
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/collection/{collection_id}
-     *
-     * Get collection details by ID.
-     *
-     * @param collection_id Unique identifier for the collection
-     * @param language Language for the response
-     * @reference https://developer.themoviedb.org/reference/collection-details
-     */
-    async details(params) {
-        const { language = this.defaultOptions.language, ...rest } = params;
-        const endpoint = this.collectionPath(params.collection_id);
-        return this.client.request(endpoint, { language, ...rest });
-    }
-    /**
-     * Images
-     * GET - https://api.themoviedb.org/3/collection/{collection_id}/images
-     *
-     * Get the images that belong to a collection.
-     * This method will return the backdrops and posters that have been added to a collection.
-     *
-     * @param collection_id Unique identifier for the collection
-     * @param language Language for the response
-     * @param include_image_language Additional language for images
-     * @reference https://developer.themoviedb.org/reference/collection-images
-     */
-    async images(params) {
-        const endpoint = `${this.collectionPath(params.collection_id)}${ENDPOINTS.COLLECTIONS.IMAGES}`;
-        const requestParams = this.withLanguage(params) ?? params;
-        return this.client.request(endpoint, requestParams);
-    }
-    /**
-     * Translations
-     * GET - https://api.themoviedb.org/3/collection/{collection_id}/translations
-     *
-     * Get collection translations by ID.
-     *
-     * @param collection_id Unique identifier for the collection
-     * @reference https://developer.themoviedb.org/reference/collection-translations
-     */
-    async translations(params) {
-        const endpoint = `${this.collectionPath(params.collection_id)}${ENDPOINTS.COLLECTIONS.TRANSLATIONS}`;
-        return this.client.request(endpoint, params);
-    }
-}

package/dist/endpoints/companies.d.ts

@@ -1,37 +0,0 @@
-import { Company, CompanyAlternativeNames, CompanyAlternativeNamesParams, CompanyImages, CompanyImagesParams, CompanyDetailsParams } from "../types/companies";
-import { TMDBAPIBase } from "./base";
-export declare class CompaniesAPI extends TMDBAPIBase {
-    private companyPath;
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/company/{company_id}
-     *
-     * Get the company details by ID.
-     *
-     * @param company_id Unique identifier for the company
-     * @reference https://developer.themoviedb.org/reference/company-details
-     */
-    details(params: CompanyDetailsParams): Promise<Company>;
-    /**
-     * Alternative names
-     * GET - https://api.themoviedb.org/3/company/{company_id}/alternative_names
-     *
-     * Get the list of alternative names for a company.
-     *
-     * @param company_id Unique identifier for the company
-     * @reference https://developer.themoviedb.org/reference/company-alternative-names
-     */
-    alternative_names(params: CompanyAlternativeNamesParams): Promise<CompanyAlternativeNames>;
-    /**
-     * Images
-     * GET - https://api.themoviedb.org/3/company/{company_id}/images
-     *
-     * Get the logos for a company by ID.
-     *
-     * @param company_id Unique identifier for the company
-     * @param language Language for the response
-     * @param include_image_language Additional language for images
-     * @reference https://developer.themoviedb.org/reference/company-images
-     */
-    images(params: CompanyImagesParams): Promise<CompanyImages>;
-}

package/dist/endpoints/companies.js

@@ -1,49 +0,0 @@
-import { ENDPOINTS } from "../routes";
-import { TMDBAPIBase } from "./base";
-export class CompaniesAPI extends TMDBAPIBase {
-    companyPath(company_id) {
-        return `${ENDPOINTS.COMPANIES.DETAILS}/${company_id}`;
-    }
-    /**
-     * Details
-     * GET - https://api.themoviedb.org/3/company/{company_id}
-     *
-     * Get the company details by ID.
-     *
-     * @param company_id Unique identifier for the company
-     * @reference https://developer.themoviedb.org/reference/company-details
-     */
-    async details(params) {
-        const endpoint = this.companyPath(params.company_id);
-        return this.client.request(endpoint, params);
-    }
-    /**
-     * Alternative names
-     * GET - https://api.themoviedb.org/3/company/{company_id}/alternative_names
-     *
-     * Get the list of alternative names for a company.
-     *
-     * @param company_id Unique identifier for the company
-     * @reference https://developer.themoviedb.org/reference/company-alternative-names
-     */
-    async alternative_names(params) {
-        const endpoint = `${this.companyPath(params.company_id)}${ENDPOINTS.COMPANIES.ALTERNATIVE_NAMES}`;
-        return this.client.request(endpoint, params);
-    }
-    /**
-     * Images
-     * GET - https://api.themoviedb.org/3/company/{company_id}/images
-     *
-     * Get the logos for a company by ID.
-     *
-     * @param company_id Unique identifier for the company
-     * @param language Language for the response
-     * @param include_image_language Additional language for images
-     * @reference https://developer.themoviedb.org/reference/company-images
-     */
-    async images(params) {
-        const endpoint = `${this.companyPath(params.company_id)}${ENDPOINTS.COMPANIES.IMAGES}`;
-        const requestParams = this.withLanguage(params) ?? params;
-        return this.client.request(endpoint, requestParams);
-    }
-}