@lorenzopant/tmdb 0.0.18 → 1.0.0

package/dist/images/images.d.ts

@@ -0,0 +1,13 @@
+import { ImagesConfig } from "../types";
+import { BackdropSize, LogoSize, PosterSize, ProfileSize, StillSize } from "../types/images";
+export declare class ImageAPI {
+    private options;
+    constructor(options?: ImagesConfig);
+    private buildUrl;
+    backdrop(path: string, size?: BackdropSize): string;
+    logo(path: string, size?: LogoSize): string;
+    poster(path: string, size?: PosterSize): string;
+    profile(path: string, size?: ProfileSize): string;
+    still(path: string, size?: StillSize): string;
+}
+//# sourceMappingURL=images.d.ts.map

package/dist/images/images.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../../src/images/images.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,YAAY,EAAyC,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEpI,qBAAa,QAAQ;IACpB,OAAO,CAAC,OAAO,CAAe;gBAElB,OAAO,GAAE,YAAiB;IAItC,OAAO,CAAC,QAAQ;IAKT,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,YAAoE,GAAG,MAAM;IAI1G,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,QAA4D,GAAG,MAAM;IAI9F,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,UAAgE,GAAG,MAAM;IAIpG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,WAAkE,GAAG,MAAM;IAIvG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,SAA6D,GAAG,MAAM;CAGvG"}

package/dist/images/images.js

@@ -0,0 +1,26 @@
+import { IMAGE_BASE_URL, IMAGE_SECURE_BASE_URL } from "../types/images";
+export class ImageAPI {
+    options;
+    constructor(options = {}) {
+        this.options = { secure_images_url: true, ...options };
+    }
+    buildUrl(path, size) {
+        const baseUrl = this.options.secure_images_url ? IMAGE_SECURE_BASE_URL : IMAGE_BASE_URL;
+        return `${baseUrl}${size}${path}`;
+    }
+    backdrop(path, size = this.options.default_image_sizes?.backdrops || "w780") {
+        return this.buildUrl(path, size);
+    }
+    logo(path, size = this.options.default_image_sizes?.logos || "w185") {
+        return this.buildUrl(path, size);
+    }
+    poster(path, size = this.options.default_image_sizes?.posters || "w500") {
+        return this.buildUrl(path, size);
+    }
+    profile(path, size = this.options.default_image_sizes?.profiles || "w185") {
+        return this.buildUrl(path, size);
+    }
+    still(path, size = this.options.default_image_sizes?.still || "w300") {
+        return this.buildUrl(path, size);
+    }
+}

package/dist/tests/images/images.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=images.test.d.ts.map

package/dist/tests/images/images.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.test.d.ts","sourceRoot":"","sources":["../../../src/tests/images/images.test.ts"],"names":[],"mappings":""}

package/dist/tests/images/images.test.js

@@ -0,0 +1,43 @@
+import { describe, expect, test } from "vitest";
+import { IMAGE_SECURE_BASE_URL, IMAGE_BASE_URL } from "../../types/images";
+import { ImageAPI } from "../../images/images";
+describe("ImageAPI", () => {
+    const path = "/sample.jpg";
+    test("should generate secure poster URL by default", () => {
+        const imageAPI = new ImageAPI();
+        const poster_path = "/1E5baAaEse26fej7uHcjOgEE2t2.jpg"; // Fast X
+        const url = imageAPI.poster(poster_path);
+        expect(url).toBe(`${IMAGE_SECURE_BASE_URL}w500${poster_path}`);
+    });
+    test("should generate non-secure poster URL when configured", () => {
+        const poster_path = "/1E5baAaEse26fej7uHcjOgEE2t2.jpg"; // Fast X
+        const imageAPI = new ImageAPI({ secure_images_url: false });
+        const url = imageAPI.poster(poster_path);
+        expect(url).toBe(`${IMAGE_BASE_URL}w500${poster_path}`);
+    });
+    test("should use default image sizes if defined", () => {
+        const imageAPI = new ImageAPI({ default_image_sizes: { posters: "original" } });
+        const url = imageAPI.poster(path);
+        expect(url).toBe(`${IMAGE_SECURE_BASE_URL}original${path}`);
+    });
+    test("should generate backdrop URL", () => {
+        const imageAPI = new ImageAPI();
+        const url = imageAPI.backdrop(path, "w1280");
+        expect(url).toBe(`${IMAGE_SECURE_BASE_URL}w1280${path}`);
+    });
+    test("should generate logo URL", () => {
+        const imageAPI = new ImageAPI();
+        const url = imageAPI.logo(path, "w300");
+        expect(url).toBe(`${IMAGE_SECURE_BASE_URL}w300${path}`);
+    });
+    test("should generate profile URL", () => {
+        const imageAPI = new ImageAPI();
+        const url = imageAPI.profile(path, "h632");
+        expect(url).toBe(`${IMAGE_SECURE_BASE_URL}h632${path}`);
+    });
+    test("should generate still URL", () => {
+        const imageAPI = new ImageAPI();
+        const url = imageAPI.still(path, "w300");
+        expect(url).toBe(`${IMAGE_SECURE_BASE_URL}w300${path}`);
+    });
+});

package/dist/tmdb.d.ts

@@ -1,6 +1,7 @@
 import { MovieListsAPI } from "./endpoints/movie_lists";
 import { MoviesAPI } from "./endpoints/movies";
 import { SearchAPI } from "./endpoints/search";
+import { ImageAPI } from "./images/images";
 import { TMDBOptions } from "./types";
 export declare class TMDB {
     private client;
@@ -8,6 +9,7 @@ export declare class TMDB {
     movies: MoviesAPI;
     movie_lists: MovieListsAPI;
     search: SearchAPI;
+    images: ImageAPI;
     /**
      * 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,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,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;IAGzB;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB;CAQ1D"}
+{"version":3,"file":"tmdb.d.ts","sourceRoot":"","sources":["../src/tmdb.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,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;IAGxB;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB;CAS1D"}

package/dist/tmdb.js

@@ -4,12 +4,14 @@ import { MovieListsAPI } from "./endpoints/movie_lists";
 import { MoviesAPI } from "./endpoints/movies";
 import { SearchAPI } from "./endpoints/search";
 import { Errors } from "./errors/messages";
+import { ImageAPI } from "./images/images";
 export class TMDB {
     client;
     options; // ** Default options for all requests
     movies;
     movie_lists;
     search;
+    images;
     // etc...
     /**
      * Creates a new TMDB instance.
@@ -24,5 +26,6 @@ export class TMDB {
         this.movies = new MoviesAPI(this.client, this.options);
         this.movie_lists = new MovieListsAPI(this.client, this.options);
         this.search = new SearchAPI(this.client, this.options);
+        this.images = new ImageAPI(this.options.images);
     }
 }

package/dist/types/images.d.ts

@@ -0,0 +1,14 @@
+export declare const IMAGE_BASE_URL = "http://image.tmdb.org/t/p/";
+export declare const IMAGE_SECURE_BASE_URL = "https://image.tmdb.org/t/p/";
+export declare const BACKDROP_SIZES: readonly ["w300", "w780", "w1280", "original"];
+export type BackdropSize = (typeof BACKDROP_SIZES)[number];
+export declare const LOGO_SIZES: readonly ["w45", "w92", "w154", "w185", "w300", "w500", "original"];
+export type LogoSize = (typeof LOGO_SIZES)[number];
+export declare const POSTER_SIZES: readonly ["w92", "w154", "w185", "w342", "w500", "w780", "original"];
+export type PosterSize = (typeof POSTER_SIZES)[number];
+export declare const PROFILE_SIZES: readonly ["w45", "w185", "h632", "original"];
+export type ProfileSize = (typeof PROFILE_SIZES)[number];
+export declare const STILL_SIZES: readonly ["w92", "w185", "w300", "original"];
+export type StillSize = (typeof STILL_SIZES)[number];
+export type ImageSize = BackdropSize | LogoSize | PosterSize | ProfileSize | StillSize;
+//# sourceMappingURL=images.d.ts.map

package/dist/types/images.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../../src/types/images.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,cAAc,+BAA+B,CAAC;AAC3D,eAAO,MAAM,qBAAqB,gCAAgC,CAAC;AAGnE,eAAO,MAAM,cAAc,gDAAiD,CAAC;AAC7E,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAG3D,eAAO,MAAM,UAAU,qEAAsE,CAAC;AAC9F,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAGnD,eAAO,MAAM,YAAY,sEAAuE,CAAC;AACjG,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAGvD,eAAO,MAAM,aAAa,8CAA+C,CAAC;AAC1E,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAGzD,eAAO,MAAM,WAAW,8CAA+C,CAAC;AACxE,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAGrD,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,CAAC"}

package/dist/types/images.js

@@ -0,0 +1,13 @@
+// Image base URLs
+export const IMAGE_BASE_URL = "http://image.tmdb.org/t/p/";
+export const IMAGE_SECURE_BASE_URL = "https://image.tmdb.org/t/p/";
+// Backdrop sizes
+export const BACKDROP_SIZES = ["w300", "w780", "w1280", "original"];
+// Logo sizes
+export const LOGO_SIZES = ["w45", "w92", "w154", "w185", "w300", "w500", "original"];
+// Poster sizes
+export const POSTER_SIZES = ["w92", "w154", "w185", "w342", "w500", "w780", "original"];
+// Profile sizes
+export const PROFILE_SIZES = ["w45", "w185", "h632", "original"];
+// Still sizes
+export const STILL_SIZES = ["w92", "w185", "w300", "original"];

package/dist/types/index.d.ts

@@ -5,4 +5,5 @@ export * from "./lang";
 export * from "./movies";
 export * from "./params";
 export * from "./utility";
+export * from "./images";
 //# sourceMappingURL=index.d.ts.map

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

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

package/dist/types/index.js

@@ -5,3 +5,4 @@ export * from "./lang";
 export * from "./movies";
 export * from "./params";
 export * from "./utility";
+export * from "./images";

package/dist/types/utility.d.ts

@@ -1,4 +1,5 @@
 import { CountryISO3166_1 } from "./countries";
+import { BackdropSize, LogoSize, PosterSize, ProfileSize, StillSize } from "./images";
 import { LanguageISO6391 } from "./lang";
 export type TMDBOptions = {
     /**
@@ -13,5 +14,28 @@ export type TMDBOptions = {
      * If not set, TMDB may fall back to a default or global data.
      */
     region?: CountryISO3166_1;
+    /**
+     * Provide images default configuration
+     */
+    images?: ImagesConfig;
+};
+export type ImagesConfig = {
+    /**
+     * Whether to use the secure (HTTPS) image base URL.
+     * Defaults to true. Set to false only if working in an environment where HTTPS is not supported
+     * or where you explicitly need non-secure image URLs.
+     */
+    secure_images_url?: boolean;
+    /**
+     * Provide default image size configuration for each type of images.
+     */
+    default_image_sizes?: Partial<DefaultImageSizesConfig>;
+};
+export type DefaultImageSizesConfig = {
+    posters?: PosterSize;
+    backdrops?: BackdropSize;
+    logos?: LogoSize;
+    profiles?: ProfileSize;
+    still?: StillSize;
 };
 //# sourceMappingURL=utility.d.ts.map

package/dist/types/utility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utility.d.ts","sourceRoot":"","sources":["../../src/types/utility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"utility.d.ts","sourceRoot":"","sources":["../../src/types/utility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACrC,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,KAAK,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC"}

package/package.json

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

package/vitest.config.mts

@@ -8,6 +8,7 @@ export default defineConfig({
 		coverage: {
 			enabled: true,
 			reporter: ["text", "json", "html", "clover"],
+			exclude: ["src/types/**", "dist/**", "vitest.config.mts", "eslint.config.mjs", ".eslintrc.js", "src/index.ts"],
 		},
 		setupFiles: ["dotenv/config"],
 		env: loadEnv(process.cwd(), ""),