feat(tmdb): rework auth

Author: dvcol

src/models/tmdb/tmdb-account.model.ts

@@ -0,0 +1,20 @@
+export type TmdbAccountAvatar = {
+  gravatar: {
+    hash: string;
+  };
+  tmdb: {
+    avatar_path: string;
+  };
+};
+
+export type TmdbAccount = {
+  id: number;
+  name: string;
+  username: string;
+  include_adult: boolean;
+  /** The ISO 3166-1 code of the country */
+  iso_3166_1: string;
+  /** The ISO 639-1 code of the language */
+  iso_639_1: string;
+  avatar: TmdbAccountAvatar;
+};

src/models/tmdb/tmdb-client.model.ts

@@ -15,6 +15,8 @@ export type TmdbClientSettings = {
   endpoint: string;
   /** The consumer client identifier */
   useragent: string;
+  /** The app api key  */
+  apiKey: string;
   /** The app read-only api key  */
   readToken: string;
   /** token time-to-live (15 minutes) */
@@ -24,8 +26,12 @@ export type TmdbClientSettings = {
 export type TmdbClientAuthentication = {
   /** User access token if there is an active session */
   accessToken?: string;
-  /** The app read-only api key  */
-  readToken?: string;
+  /** If the session id is for a guest session */
+  isGuest?: boolean;
+  /** The user session id  */
+  sessionId?: string;
+  /** The user sessionId expire date */
+  expiresAt?: string;
 };
 
 export type TmdbParamPagination = {
@@ -63,7 +69,9 @@ export type TmdbApiResponse<T = unknown> = ResponseOrTypedResponse<T>;
 export type TmdbApiQuery<T = unknown> = BaseQuery<BaseRequest, T>;
 export type TmdbApiTemplateOptions = BaseTemplateOptions & {
   /** If the method requires user authentication */
-  auth?: boolean;
+  auth?: 'session' | 'token' | false;
+  /** If the method is authorized for a guest session id */
+  guest?: boolean;
   /** The api version (3 or 4) */
   version: number | string;
 };

src/models/tmdb/tmdb-episode.model.ts

@@ -41,3 +41,8 @@ export type TmdbEpisode<T extends EntityTypes = Short> = T extends Extended
   : T extends Short
     ? TmdbEpisodeShort
     : TmdbEpisodeExtended | TmdbEpisodeShort;
+
+export type TmdbEpisodeRating = TmdbEpisode & {
+  show_id: number;
+  rating: number;
+};

src/models/tmdb/tmdb-error.model.ts

@@ -0,0 +1,55 @@
+export type TmdbError = {
+  code: number;
+  status: number;
+  message: string;
+};
+
+export const TmdbErrors = {
+  1: { code: 1, status: 200, message: 'Success.' },
+  2: { code: 2, status: 501, message: 'Invalid service: this service does not exist.' },
+  3: { code: 3, status: 401, message: 'Authentication failed: You do not have permissions to access the service.' },
+  4: { code: 4, status: 405, message: "Invalid format: This service doesn't exist in that format." },
+  5: { code: 5, status: 422, message: 'Invalid parameters: Your request parameters are incorrect.' },
+  6: { code: 6, status: 404, message: 'Invalid id: The pre-requisite id is invalid or not found.' },
+  7: { code: 7, status: 401, message: 'Invalid API key: You must be granted a valid key.' },
+  8: { code: 8, status: 403, message: 'Duplicate entry: The data you tried to submit already exists.' },
+  9: { code: 9, status: 503, message: 'Service offline: This service is temporarily offline, try again later.' },
+  10: { code: 10, status: 401, message: 'Suspended API key: Access to your account has been suspended, contact TMDB.' },
+  11: { code: 11, status: 500, message: 'Internal error: Something went wrong, contact TMDB.' },
+  12: { code: 12, status: 201, message: 'The item/record was updated successfully.' },
+  13: { code: 13, status: 200, message: 'The item/record was deleted successfully.' },
+  14: { code: 14, status: 401, message: 'Authentication failed.' },
+  15: { code: 15, status: 500, message: 'Failed.' },
+  16: { code: 16, status: 401, message: 'Device denied.' },
+  17: { code: 17, status: 401, message: 'Session denied.' },
+  18: { code: 18, status: 400, message: 'Validation failed.' },
+  19: { code: 19, status: 406, message: 'Invalid accept header.' },
+  20: { code: 20, status: 422, message: 'Invalid date range: Should be a range no longer than 14 days.' },
+  21: { code: 21, status: 200, message: 'Entry not found: The item you are trying to edit cannot be found.' },
+  22: { code: 22, status: 400, message: 'Invalid page: Pages start at 1 and max at 500. They are expected to be an integer.' },
+  23: { code: 23, status: 400, message: 'Invalid date: Format needs to be YYYY-MM-DD.' },
+  24: { code: 24, status: 504, message: 'Your request to the backend server timed out. Try again.' },
+  25: { code: 25, status: 429, message: 'Your request count (#) is over the allowed limit of (40).' },
+  26: { code: 26, status: 400, message: 'You must provide a username and password.' },
+  27: { code: 27, status: 400, message: 'Too many append to response objects: The maximum number of remote calls is 20.' },
+  28: { code: 28, status: 400, message: 'Invalid timezone: Please consult the documentation for a valid timezone.' },
+  29: { code: 29, status: 400, message: 'You must confirm this action: Please provide a confirm=true parameter.' },
+  30: { code: 30, status: 401, message: 'Invalid username and/or password: You did not provide a valid login.' },
+  31: { code: 31, status: 401, message: 'Account disabled: Your account is no longer active. Contact TMDB if this is an error.' },
+  32: { code: 32, status: 401, message: 'Email not verified: Your email address has not been verified.' },
+  33: { code: 33, status: 401, message: 'Invalid request token: The request token is either expired or invalid.' },
+  34: { code: 34, status: 404, message: 'The resource you requested could not be found.' },
+  35: { code: 35, status: 401, message: 'Invalid token.' },
+  36: { code: 36, status: 401, message: "This token hasn't been granted write permission by the user." },
+  37: { code: 37, status: 404, message: 'The requested session could not be found.' },
+  38: { code: 38, status: 401, message: "You don't have permission to edit this resource." },
+  39: { code: 39, status: 401, message: 'This resource is private.' },
+  40: { code: 40, status: 200, message: 'Nothing to update.' },
+  41: { code: 41, status: 422, message: "This request token hasn't been approved by the user." },
+  42: { code: 42, status: 405, message: 'This request method is not supported for this resource.' },
+  43: { code: 43, status: 502, message: "Couldn't connect to the backend server." },
+  44: { code: 44, status: 500, message: 'The ID is invalid.' },
+  45: { code: 45, status: 403, message: 'This user has been suspended.' },
+  46: { code: 46, status: 503, message: 'The API is undergoing maintenance. Try again later.' },
+  47: { code: 47, status: 400, message: 'The input is not valid.' },
+};

src/models/tmdb/tmdb-list.model.ts

@@ -35,9 +35,16 @@ export type TmdbListV4 = BaseTmdbList & {
   item_count: number;
   object_ids: Record<string, string>;
   sort_by: string;
+};
 
-  // page: number;
-  // results: TmdbMovieShort[];
-  // total_pages: number;
-  // total_results: number;
+export type TmdbListV3 = {
+  id: number;
+  item_count: number;
+  description: string;
+  favorite_count: number;
+  /** The ISO 639-1 code of the language */
+  iso_639_1: string;
+  list_type: 'movie' | 'tv';
+  name: string;
+  poster_path: string;
 };

src/services/common/base-client.test.ts

@@ -484,7 +484,7 @@ describe('base-client.ts', () => {
       expect(result).toBe('{"requiredBody":"requiredBody"}');
     });
 
-    it('should parse body to JSON string', () => {
+    it('should throw an error for missing mandatory body parameter', () => {
       expect.assertions(1);
 
       const mockBody: Record<string, unknown> = { ...mockParams, optionalBody: 'optionalBody' };

src/services/common/base-client.ts

@@ -414,7 +414,7 @@ export const parseBody = <T extends RecursiveRecord = RecursiveRecord>(template:
   });
 
   Object.keys(template).forEach(key => {
-    if (template[key] === true && !(key in _body)) throw new Error(`Missing mandatory body parameter: '${key}'`);
+    if (template[key] === true && [undefined, null, ''].includes(params[key])) throw new Error(`Missing mandatory body parameter: '${key}'`);
   });
 
   return JSON.stringify(_body);
@@ -471,7 +471,7 @@ export const parseUrl = <P extends RecursiveRecord = RecursiveRecord, O extends
       const _value = params[key] ?? value;
 
       // If a value is found we encode
-      if (_value !== undefined && _value !== '') {
+      if (![undefined, null, ''].includes(_value)) {
         url.searchParams.set(key, typeof _value === 'object' ? JSON.stringify(_value) : _value);
       }
       // If the parameter is required we raise error