fix(bundle): use minimal conf to allow treeshaking

Author: dvcol

src/services/tmdb-client/api/tmdb-api.endpoint.ts src/services/tmdb-client/api/tmdb-api.endpoints.ts

@@ -6,5 +6,4 @@ export const tmdbApi = {
   v4,
 };
 
-const { auth } = v4;
-export const minimalTmdbApi = { v4: { auth } };
+export type TmdbApi = typeof tmdbApi;

src/services/tmdb-client/api/tmdb-minimal-api.endpoints.ts

@@ -0,0 +1,3 @@
+import { auth } from '~/services/tmdb-client/api/endpoints/v4/auth.endpoint';
+
+export const minimalTmdbApi = { v4: { auth } };

src/services/tmdb-client/clients/base-tmdb-client.ts

@@ -12,18 +12,14 @@ import type {
   TmdbPaginatedData,
 } from '~/models/tmdb/tmdb-client.model';
 
+import type { TmdbApi } from '~/services/tmdb-client/api/tmdb-api.endpoints';
+
 import { TraktApiHeaders } from '~/models/trakt/trakt-client.model';
 import { BaseApiHeaders, type BaseBody, BaseClient, BaseHeaderContentType, parseBody, parseUrl } from '~/services/common/base-client';
-import { minimalTmdbApi, type tmdbApi } from '~/services/tmdb-client/api/tmdb-api.endpoint';
-
-/**
- * The extracted type signature of the TmdbApi
- */
-type ITmdbEndpoints = typeof tmdbApi;
 
 /** Needed to type Object assignment */
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging  -- To allow type extension
-export interface BaseTmdbClient extends ITmdbEndpoints {}
+export interface BaseTmdbClient extends TmdbApi {}
 
 const isPageResponse = (response: TmdbApiResponseData | TmdbApiResponsePageData): response is TmdbApiResponsePageData =>
   'page' in response && 'total_pages' in response && 'total_results' in response;
@@ -55,17 +51,14 @@ const parseResponse = (response: TmdbApiResponseData | TmdbApiResponsePageData)
  * @class BaseTmdbClient
  */
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging  -- To allow type extension
-export class BaseTmdbClient
-  extends BaseClient<TmdbApiQuery, TmdbApiResponse, TmdbClientSettings, TmdbClientAuthentication>
-  implements ITmdbEndpoints
-{
+export class BaseTmdbClient extends BaseClient<TmdbApiQuery, TmdbApiResponse, TmdbClientSettings, TmdbClientAuthentication> implements TmdbApi {
   /**
    * Creates an instance of BaseTmdbClient.
    * @param options - The options for the client.
    * @param authentication - The authentication for the client.
    * @param api - The API endpoints for the client.
    */
-  constructor(options: TmdbClientOptions, authentication: TmdbClientAuthentication = {}, api: ITmdbApi = minimalTmdbApi) {
+  constructor(options: TmdbClientOptions, authentication: TmdbClientAuthentication = {}, api: ITmdbApi = {}) {
     super(options, authentication, api);
   }
 

src/services/tmdb-client/clients/tmdb-client.ts

@@ -1,6 +1,6 @@
 import type { TmdbClientAuthentication, TmdbClientOptions } from '~/models/tmdb/tmdb-client.model';
 
-import { tmdbApi } from '~/services/tmdb-client/api/tmdb-api.endpoint';
+import { minimalTmdbApi } from '~/services/tmdb-client/api/tmdb-minimal-api.endpoints';
 import { BaseTmdbClient } from '~/services/tmdb-client/clients/base-tmdb-client';
 import { Config } from '~/settings/tmdb.api';
 
@@ -18,7 +18,7 @@ export class TmdbClient extends BaseTmdbClient {
    * @param authentication - The authentication for the client.
    */
   constructor(settings: TmdbClientOptions, authentication: TmdbClientAuthentication = {}) {
-    super(settings, authentication, tmdbApi);
+    super(settings, authentication, minimalTmdbApi);
   }
 
   /**

src/services/trakt-client/api/trakt-api-minimal.endpoints.ts

@@ -0,0 +1,3 @@
+import { authentication } from '~/services/trakt-client/api/endpoints/authentication.endpoint';
+
+export const minimalTraktApi = { authentication };

src/services/trakt-client/api/trakt-api.endpoints.ts

@@ -155,4 +155,4 @@ export const traktApi = {
   users,
 };
 
-export const minimalTraktApi = { authentication };
+export type TraktApi = typeof traktApi;

src/services/trakt-client/clients/base-trakt-client.ts

@@ -9,12 +9,12 @@ import type {
   TraktClientSettings,
 } from '~/models/trakt/trakt-client.model';
 
+import type { TraktApi } from '~/services/trakt-client/api/trakt-api.endpoints';
 import type { Primitive } from '~/utils/typescript.utils';
 
 import { TraktApiHeaders } from '~/models/trakt/trakt-client.model';
 
 import { type BaseBody, BaseClient, BaseHeaderContentType, parseBody, parseUrl } from '~/services/common/base-client';
-import { minimalTraktApi, type traktApi } from '~/services/trakt-client/api/trakt-api.endpoints';
 import { isFilter, TraktApiFilterValidator } from '~/services/trakt-client/api/trakt-api.filters';
 
 /**
@@ -100,32 +100,24 @@ export const parseResponse = <T>(response: Response): TraktApiResponse<T> => {
   return _response;
 };
 
-/**
- * The extracted type signature of the TraktApi
- */
-type ITraktEndpoints = typeof traktApi;
-
 /** Needed to type Object assignment */
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging  -- To allow type extension
-export interface BaseTraktClient extends ITraktEndpoints {}
+export interface BaseTraktClient extends TraktApi {}
 
 /**
  * Represents a Trakt API client with common functionality.
  *
  * @class BaseTraktClient
  */
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging  -- To allow type extension
-export class BaseTraktClient
-  extends BaseClient<TraktApiQuery, TraktApiResponse, TraktClientSettings, TraktClientAuthentication>
-  implements ITraktEndpoints
-{
+export class BaseTraktClient extends BaseClient<TraktApiQuery, TraktApiResponse, TraktClientSettings, TraktClientAuthentication> implements TraktApi {
   /**
    * Creates an instance of BaseTraktClient.
    * @param options - The options for the client.
    * @param authentication - The authentication for the client.
    * @param api - The API endpoints for the client.
    */
-  constructor(options: TraktClientOptions, authentication: TraktClientAuthentication = {}, api: ITraktApi = minimalTraktApi) {
+  constructor(options: TraktClientOptions, authentication: TraktClientAuthentication = {}, api: ITraktApi = {}) {
     super(options, authentication, api);
   }
 

src/services/trakt-client/clients/trakt-client.ts

@@ -13,7 +13,7 @@ import type {
 import type { TraktApiInit, TraktApiResponse, TraktClientOptions } from '~/models/trakt/trakt-client.model';
 
 import { TraktApiHeaders } from '~/models/trakt/trakt-client.model';
-import { traktApi } from '~/services/trakt-client/api/trakt-api.endpoints';
+import { minimalTraktApi } from '~/services/trakt-client/api/trakt-api-minimal.endpoints';
 import { randomHex } from '~/utils/crypto.utils';
 
 /**
@@ -56,7 +56,7 @@ export class TraktClient extends BaseTraktClient {
    * @param authentication - The authentication for the client.
    */
   constructor(settings: TraktClientOptions, authentication: TraktClientAuthentication = {}) {
-    super(settings, authentication, traktApi);
+    super(settings, authentication, minimalTraktApi);
   }
 
   /**

src/services/tvdb-client/api/endpoints/login.endpoint.ts

@@ -0,0 +1,28 @@
+import { TvdbClientEndpoint } from '~/models/tvdb/tvdb-client.model';
+import { HttpMethod } from '~/utils/http.utils';
+
+/**
+ * Create an auth token. The token has one month validation length.
+ *
+ * @see [login]{@link https://thetvdb.github.io/v4-api/#/Login}
+ */
+export const login = new TvdbClientEndpoint<
+  {
+    apiKey: string;
+    pin?: string;
+  },
+  {
+    token: string;
+  },
+  false
+>({
+  method: HttpMethod.POST,
+  url: '/login',
+  opts: {
+    cache: false,
+  },
+  body: {
+    apiKey: true,
+    pin: false,
+  },
+});

src/services/tvdb-client/api/tvdb-api.endpoint.ts src/services/tvdb-client/api/tvdb-api.endpoints.ts

@@ -18,6 +18,7 @@ import { episodes } from '~/services/tvdb-client/api/endpoints/episodes.endpoint
 import { favorites } from '~/services/tvdb-client/api/endpoints/favorites.endpoint';
 import { genres } from '~/services/tvdb-client/api/endpoints/genres.endpoint';
 import { lists } from '~/services/tvdb-client/api/endpoints/lists.endpoint';
+import { login } from '~/services/tvdb-client/api/endpoints/login.endpoint';
 import { movies } from '~/services/tvdb-client/api/endpoints/movies.endpoint';
 import { people } from '~/services/tvdb-client/api/endpoints/people.endpoints';
 import { search } from '~/services/tvdb-client/api/endpoints/search.endpoint';
@@ -30,31 +31,7 @@ import { HttpMethod } from '~/utils/http.utils';
  * @see [documentation]{@link https://thetvdb.github.io/v4-api/#/Login/post_login}
  */
 export const tvdbApi = {
-  /**
-   * Create an auth token. The token has one month validation length.
-   *
-   * @see [login]{@link https://thetvdb.github.io/v4-api/#/Login}
-   */
-  login: new TvdbClientEndpoint<
-    {
-      apiKey: string;
-      pin?: string;
-    },
-    {
-      token: string;
-    },
-    false
-  >({
-    method: HttpMethod.POST,
-    url: '/login',
-    opts: {
-      cache: false,
-    },
-    body: {
-      apiKey: true,
-      pin: false,
-    },
-  }),
+  login,
   artwork,
   awards,
   /**
@@ -238,5 +215,4 @@ export const tvdbApi = {
   favorites,
 };
 
-const { login } = tvdbApi;
-export const minimalTvdbApi = { login };
+export type TvdbApi = typeof tvdbApi;

src/services/tvdb-client/api/tvdb-minimal-api.endpoints.ts

@@ -0,0 +1,3 @@
+import { login } from '~/services/tvdb-client/api/endpoints/login.endpoint';
+
+export const minimalTvdbApi = { login };

src/services/tvdb-client/clients/base-tvdb-client.ts

@@ -10,36 +10,29 @@ import type {
   TvdbClientSettings,
 } from '~/models/tvdb/tvdb-client.model';
 
+import type { TvdbApi } from '~/services/tvdb-client/api/tvdb-api.endpoints';
+
 import { TraktApiHeaders } from '~/models/trakt/trakt-client.model';
 import { BaseApiHeaders, type BaseBody, BaseClient, BaseHeaderContentType, parseBody, parseUrl } from '~/services/common/base-client';
-import { minimalTvdbApi, type tvdbApi } from '~/services/tvdb-client/api/tvdb-api.endpoint';
-
-/**
- * The extracted type signature of the TvdbApi
- */
-type ITvdbEndpoints = typeof tvdbApi;
 
 /** Needed to type Object assignment */
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging  -- To allow type extension
-export interface BaseTvdbClient extends ITvdbEndpoints {}
+export interface BaseTvdbClient extends TvdbApi {}
 
 /**
  * Represents a Tvdb API client with common functionality.
  *
  * @class BaseTvdbClient
  */
 // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging  -- To allow type extension
-export class BaseTvdbClient
-  extends BaseClient<TvdbApiQuery, TvdbApiResponse, TvdbClientSettings, TvdbClientAuthentication>
-  implements ITvdbEndpoints
-{
+export class BaseTvdbClient extends BaseClient<TvdbApiQuery, TvdbApiResponse, TvdbClientSettings, TvdbClientAuthentication> implements TvdbApi {
   /**
    * Creates an instance of BaseTvdbClient.
    * @param options - The options for the client.
    * @param authentication - The authentication for the client.
    * @param api - The API endpoints for the client.
    */
-  constructor(options: TvdbClientOptions, authentication: TvdbClientAuthentication = {}, api: ITvdbApi = minimalTvdbApi) {
+  constructor(options: TvdbClientOptions, authentication: TvdbClientAuthentication = {}, api: ITvdbApi = {}) {
     super(options, authentication, api);
   }
 

src/services/tvdb-client/clients/tvdb-client.test.ts

@@ -7,7 +7,7 @@ import { HttpMethod } from '../../../utils/http.utils';
 import { BaseApiHeaders, BaseHeaderContentType } from '../../common/base-client';
 
 import { hasOwnProperty } from '../../common/test.utils';
-import { tvdbApi } from '../api/tvdb-api.endpoint';
+import { tvdbApi } from '../api/tvdb-api.endpoints';
 
 import { TvdbClient } from './tvdb-client';
 

src/services/tvdb-client/clients/tvdb-client.ts

@@ -1,6 +1,6 @@
 import type { TvdbClientAuthentication, TvdbClientOptions } from '~/models/tvdb/tvdb-client.model';
 
-import { tvdbApi } from '~/services/tvdb-client/api/tvdb-api.endpoint';
+import { minimalTvdbApi } from '~/services/tvdb-client/api/tvdb-minimal-api.endpoints';
 import { BaseTvdbClient } from '~/services/tvdb-client/clients/base-tvdb-client';
 
 /**
@@ -17,7 +17,7 @@ export class TvdbClient extends BaseTvdbClient {
    * @param authentication - The authentication for the client.
    */
   constructor(settings: TvdbClientOptions, authentication: TvdbClientAuthentication = {}) {
-    super(settings, authentication, tvdbApi);
+    super(settings, authentication, minimalTvdbApi);
   }
 
   /**