@lorenzopant/tmdb 1.2.0 → 1.3.0

package/README.md

@@ -1,4 +1,4 @@
-# TMDB API TS
+# 🍿 @lorenzopant/tmdb
 
 A **TypeScript-first** lightweight client for [The Movie Database (TMDB)](https://developer.themoviedb.org/docs/getting-started) API.
 
@@ -9,7 +9,7 @@ Feel free to open pull requests on the project repository.
 - 🔥 Simple and tiny wrapper
 - 🚀 Designed for server-side and frontend use (NextJS, React, Vue, etc.)
 
-## Full documentation is available at [@lorenzopant/tmdb](https://lorenzopant-docs.vercel.app/)
+## Full documentation is available at [@lorenzopant/tmdb](https://lorenzopant-tmdb-docs.vercel.app)
 
 ---
 
@@ -17,6 +17,10 @@ Feel free to open pull requests on the project repository.
 
 ```bash
 npm install @lorenzopant/tmdb
+// or
+pnpm add @lorenzopant/tmdb
+// or
+yard add @lorenzopant/tmdb
 ```
 
 ---

package/dist/endpoints/certifications.d.ts

@@ -0,0 +1,21 @@
+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>;
+}
+//# sourceMappingURL=certifications.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"certifications.d.ts","sourceRoot":"","sources":["../../src/endpoints/certifications.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,qBAAa,iBAAkB,SAAQ,WAAW;IACjD;;;;;;OAMG;IACG,oBAAoB,IAAI,OAAO,CAAC,cAAc,CAAC;IAIrD;;;;;;OAMG;IACG,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;CAGlD"}

package/dist/endpoints/certifications.js

@@ -0,0 +1,24 @@
+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/routes.d.ts

@@ -7,5 +7,9 @@ export declare const ENDPOINTS: {
         TIMEZONES: string;
         PRIMARY_TRANSLATIONS: string;
     };
+    CERTIFICATIONS: {
+        MOVIE_CERTIFICATIONS: string;
+        TV_CERTIFICATIONS: string;
+    };
 };
 //# sourceMappingURL=routes.d.ts.map

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;;;;;;;;;CASrB,CAAC"}
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;;;;;;;;;CAarB,CAAC"}

package/dist/routes.js

@@ -7,4 +7,8 @@ export const ENDPOINTS = {
         TIMEZONES: "/configuration/timezones",
         PRIMARY_TRANSLATIONS: "/configuration/primary_translations",
     },
+    CERTIFICATIONS: {
+        MOVIE_CERTIFICATIONS: "/certification/movie/list",
+        TV_CERTIFICATIONS: "/certification/tv/list",
+    },
 };

package/dist/tmdb.d.ts

@@ -1,3 +1,4 @@
+import { CertificationsAPI } from "./endpoints/certifications";
 import { ConfigurationAPI } from "./endpoints/configuration";
 import { GenresAPI } from "./endpoints/genres";
 import { MovieListsAPI } from "./endpoints/movie_lists";
@@ -18,6 +19,7 @@ export declare class TMDB {
     genres: GenresAPI;
     tv_lists: TVSeriesListsAPI;
     tv_series: TVSeriesAPI;
+    certifications: CertificationsAPI;
     /**
      * 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,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;IAG9B;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB;CAa1D"}
+{"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,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;IAGzC;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB;CAc1D"}

package/dist/tmdb.js

@@ -1,5 +1,6 @@
 // src.tmdb.ts
 import { ApiClient } from "./client";
+import { CertificationsAPI } from "./endpoints/certifications";
 import { ConfigurationAPI } from "./endpoints/configuration";
 import { GenresAPI } from "./endpoints/genres";
 import { MovieListsAPI } from "./endpoints/movie_lists";
@@ -20,6 +21,7 @@ export class TMDB {
     genres;
     tv_lists;
     tv_series;
+    certifications;
     // etc...
     /**
      * Creates a new TMDB instance.
@@ -39,5 +41,6 @@ export class TMDB {
         this.genres = new GenresAPI(this.client, this.options);
         this.tv_lists = new TVSeriesListsAPI(this.client, this.options);
         this.tv_series = new TVSeriesAPI(this.client, this.options);
+        this.certifications = new CertificationsAPI(this.client, this.options);
     }
 }

package/dist/types/common/certifications.d.ts

@@ -0,0 +1,20 @@
+import { CountryISO3166_1 } from "../config";
+/**
+ * Represents a content rating certification for a movie or TV show.
+ */
+export type CertificationItem = {
+    /** The certification label as defined by the rating authority (e.g. `PG-13`, `18+`, `R`) */
+    certification: string;
+    /** A human-readable description of the audience this certification targets or restricts */
+    meaning?: string;
+    /** The display order of this certification relative to others in the same rating system */
+    order?: number;
+};
+/**
+ * A map of content rating certifications grouped by country.
+ */
+export type Certifications = {
+    /** A record mapping each country (ISO 3166-1 alpha-2 code) to its list of applicable certifications */
+    certifications: Record<CountryISO3166_1, CertificationItem[]>;
+};
+//# sourceMappingURL=certifications.d.ts.map

package/dist/types/common/certifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"certifications.d.ts","sourceRoot":"","sources":["../../../src/types/common/certifications.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B,4FAA4F;IAC5F,aAAa,EAAE,MAAM,CAAC;IACtB,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2FAA2F;IAC3F,KAAK,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,uGAAuG;IACvG,cAAc,EAAE,MAAM,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,CAAC,CAAC;CAC9D,CAAC"}

package/dist/types/common/certifications.js

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

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

@@ -2,4 +2,5 @@ export * from "./changes";
 export * from "./media";
 export * from "./pagination";
 export * from "./params";
+export * from "./certifications";
 //# sourceMappingURL=index.d.ts.map

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

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

package/dist/types/common/index.js

@@ -2,3 +2,4 @@ export * from "./changes";
 export * from "./media";
 export * from "./pagination";
 export * from "./params";
+export * from "./certifications";

package/package.json

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