@lorenzopant/tmdb 0.0.19 → 1.0.0

package/dist/images/images.d.ts

@@ -1,7 +1,8 @@
+import { ImagesConfig } from "../types";
 import { BackdropSize, LogoSize, PosterSize, ProfileSize, StillSize } from "../types/images";
 export declare class ImageAPI {
-    private useSecure;
-    constructor(useSecure?: boolean);
+    private options;
+    constructor(options?: ImagesConfig);
     private buildUrl;
     backdrop(path: string, size?: BackdropSize): string;
     logo(path: string, size?: LogoSize): string;

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

@@ -1 +1 @@
-{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../../src/images/images.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAyC,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEpI,qBAAa,QAAQ;IACpB,OAAO,CAAC,SAAS,CAAU;gBAEf,SAAS,GAAE,OAAc;IAIrC,OAAO,CAAC,QAAQ;IAKT,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,YAAqB,GAAG,MAAM;IAI3D,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,QAAiB,GAAG,MAAM;IAInD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,UAAmB,GAAG,MAAM;IAIvD,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,WAAoB,GAAG,MAAM;IAIzD,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,SAAkB,GAAG,MAAM;CAG5D"}
+{"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

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

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

@@ -11,10 +11,15 @@ describe("ImageAPI", () => {
     });
     test("should generate non-secure poster URL when configured", () => {
         const poster_path = "/1E5baAaEse26fej7uHcjOgEE2t2.jpg"; // Fast X
-        const imageAPI = new ImageAPI(false);
+        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");

package/dist/tmdb.js

@@ -26,6 +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.secure_images_url);
+        this.images = new ImageAPI(this.options.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,11 +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;IAC1B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC5B,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.19",
+  "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",