@jellyfin/sdk 0.12.0 → 0.13.0

package/CHANGELOG.md

@@ -7,11 +7,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## [Unreleased]
 
+## [0.13.0] - 2025-10-28
+
+### Changed
+
+* Ensure `Authorization` header is sent for all requests ([#948](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/948)).
+
+### Deprecated
+
+* Deprecate authentication helper methods in `Api` class ([#949](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/948)).
+  Updating the `accessToken` is now handled transparently in `getUserApi` and `getSessionApi`. If you need to handle
+  authentication manually, then you should manually create `UserApi` and `SessionApi` instances.
+
 ## [0.12.0] - 2025-10-21
 
 ### Security
 
-* Bumped axios peer dependency version ([#939](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/939)). Note that this axios vulnerability only affected applications running in node.js.
+* Bumped axios peer dependency version ([#939](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/939)).
+  Note that this axios vulnerability only affected applications running in node.js.
 
 ### Added
 
@@ -81,7 +94,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 * API classes are no longer exposed via getters.
   Instead you need to call a function passing the `Api` instance as a parameter.
   For example: `getSystemApi(api)`.
-  While I do feel this is a slightly worse developer experience, it was a necessary change to support tree-shaking ([#149](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/149)).
+  While I do feel this is a slightly worse developer experience, it was a necessary change to support tree-shaking
+  ([#149](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/149)).
 * `BaseItemKind` is now included in the generated client.
   Imports will need updated ([#187](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/187)).
 
@@ -106,7 +120,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## [0.1.0] - 2021-09-19
 
-[unreleased]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.12.0...HEAD
+[unreleased]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.13.0...HEAD
+[0.13.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.12.0...v0.13.0
 [0.12.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.11.0...v0.12.0
 [0.11.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.10.0...v0.11.0
 [0.10.0]: https://github.com/jellyfin/jellyfin-sdk-typescript/compare/v0.9.0...v0.10.0

package/README.md

@@ -35,6 +35,7 @@ yarn add @jellyfin/sdk
 
 | SDK Version | Jellyfin Version |
 |:-:|:-:|
+| 0.13.0 | 10.11.x |
 | 0.12.0 | 10.11.x |
 | 0.11.0 | 10.10.x |
 | 0.10.0 | 10.9.x |
@@ -92,10 +93,8 @@ console.log('Info =>', info.data);
 const users = await getUserApi(api).getPublicUsers();
 console.log('Users =>', users.data);
 
-// A helper method for authentication has been added to the SDK because
-// the default method exposed in the generated Axios client is rather
-// cumbersome to use.
-const auth = await api.authenticateUserByName('demo', '');
+// Login with a username and password.
+const auth = await getUserApi(this).authenticateUserByName({ authenticateUserByName: { Username: 'demo', Pw: '' } });
 console.log('Auth =>', auth.data);
 
 // Authentication state is stored internally in the Api class, so now
@@ -103,12 +102,11 @@ console.log('Auth =>', auth.data);
 const libraries = await getLibraryApi(api).getMediaFolders();
 console.log('Libraries =>', libraries.data);
 
-// A helper method for logging out the current user has been added to the
-// SDK so the internal state is updated correctly.
-await api.logout();
+// Logout the current user.
+await getSessionApi(api).reportSessionEnded();
 ```
 
-## Breaking Changes
+## Significant Changes
 
 [See the CHANGELOG](./CHANGELOG.md)
 

package/lib/api.d.ts

@@ -19,7 +19,8 @@ export declare class Api {
     constructor(basePath: string, clientInfo: ClientInfo, deviceInfo: DeviceInfo, accessToken?: string, axiosInstance?: AxiosInstance);
     get configuration(): Configuration;
     /**
-     * Convenience method for authenticating a user by name and updating the internal state.
+     * Convenience method for authenticating a user by name.
+     * @deprecated Use `getUserApi().authenticateUserByName()` instead.
      * @param username The username.
      * @param password The user password if required.
      */
@@ -32,7 +33,8 @@ export declare class Api {
      */
     getUri(url: string, params?: object): string;
     /**
-     * Convenience method for logging out and updating the internal state.
+     * Convenience method for logging out.
+     * @deprecated Use `getSessionApi().reportSessionEnded()` instead.
      */
     logout(): Promise<AxiosResponse<never> | AxiosResponse<void>>;
     get authorizationHeader(): string;

package/lib/api.js

@@ -19,24 +19,23 @@ class Api {
     get configuration() {
         return new Configuration({
             basePath: this.basePath,
-            apiKey: this.authorizationHeader
+            baseOptions: {
+                headers: {
+                    [AUTHORIZATION_HEADER]: this.authorizationHeader
+                }
+            }
         });
     }
     /**
-     * Convenience method for authenticating a user by name and updating the internal state.
+     * Convenience method for authenticating a user by name.
+     * @deprecated Use `getUserApi().authenticateUserByName()` instead.
      * @param username The username.
      * @param password The user password if required.
      */
     authenticateUserByName(username, password) {
         return getUserApi(this).authenticateUserByName(
         // The axios client does some strange wrapping of the param object
-        { authenticateUserByName: { Username: username, Pw: password } }, 
-        // The authorization header is required for the request to succeed
-        { headers: { [AUTHORIZATION_HEADER]: this.authorizationHeader } }).then(response => {
-            // Update the current token and configuration object
-            this.accessToken = response.data.AccessToken || '';
-            return response;
-        });
+        { authenticateUserByName: { Username: username, Pw: password } });
     }
     /**
      * Gets a full URI for a relative URL to the Jellyfin server for a given SDK Api instance.
@@ -52,13 +51,11 @@ class Api {
         });
     }
     /**
-     * Convenience method for logging out and updating the internal state.
+     * Convenience method for logging out.
+     * @deprecated Use `getSessionApi().reportSessionEnded()` instead.
      */
     logout() {
-        return getSessionApi(this).reportSessionEnded().then(response => {
-            this.accessToken = '';
-            return response;
-        });
+        return getSessionApi(this).reportSessionEnded();
     }
     get authorizationHeader() {
         return getAuthorizationHeader(this.clientInfo, this.deviceInfo, this.accessToken);

package/lib/utils/api/session-api.js

@@ -5,8 +5,23 @@ import { SessionApi } from '../../generated-client/api/session-api.js';
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+/** An augmented SessionApi that updates the state of the access token in the Api instance. */
+class AugmentedSessionApi extends SessionApi {
+    constructor(api) {
+        super(api.configuration, undefined, api.axiosInstance);
+        this.api = api;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-empty-object-type
+    reportSessionEnded(options) {
+        return super.reportSessionEnded(options)
+            .then(response => {
+            this.api.accessToken = '';
+            return response;
+        });
+    }
+}
 function getSessionApi(api) {
-    return new SessionApi(api.configuration, undefined, api.axiosInstance);
+    return new AugmentedSessionApi(api);
 }
 
 export { getSessionApi };

package/lib/utils/api/user-api.js

@@ -5,8 +5,33 @@ import { UserApi } from '../../generated-client/api/user-api.js';
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+/** An augmented UserApi that updates the state of the access token in the Api instance. */
+class AugmentedUserApi extends UserApi {
+    constructor(api) {
+        super(api.configuration, undefined, api.axiosInstance);
+        this.api = api;
+    }
+    authenticateUserByName(requestParameters, options
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-empty-object-type
+    ) {
+        return super.authenticateUserByName(requestParameters, options)
+            .then(response => {
+            this.api.accessToken = response.data.AccessToken || '';
+            return response;
+        });
+    }
+    authenticateWithQuickConnect(requestParameters, options
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-empty-object-type
+    ) {
+        return super.authenticateWithQuickConnect(requestParameters, options)
+            .then(response => {
+            this.api.accessToken = response.data.AccessToken || '';
+            return response;
+        });
+    }
+}
 function getUserApi(api) {
-    return new UserApi(api.configuration, undefined, api.axiosInstance);
+    return new AugmentedUserApi(api);
 }
 
 export { getUserApi };

package/lib/versions.d.ts

@@ -4,6 +4,6 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 /** The current API version of the generated client. */
-export declare const API_VERSION = "10.11.0";
+export declare const API_VERSION = "10.11.1";
 /** The minimum supported server version. */
 export declare const MINIMUM_VERSION = "10.10.0";

package/lib/versions.js

@@ -4,7 +4,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 /** The current API version of the generated client. */
-const API_VERSION = '10.11.0';
+const API_VERSION = '10.11.1';
 /** The minimum supported server version. */
 const MINIMUM_VERSION = '10.10.0';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jellyfin/sdk",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "A TypeScript SDK for Jellyfin.",
   "keywords": [
     "jellyfin"
@@ -30,15 +30,16 @@
     "@rollup/plugin-typescript": "12.1.4",
     "@stylistic/eslint-plugin": "2.13.0",
     "@tsconfig/recommended": "1.0.10",
-    "@typescript-eslint/eslint-plugin": "8.46.1",
-    "@typescript-eslint/parser": "8.46.1",
+    "@types/node": "24.9.1",
+    "@typescript-eslint/eslint-plugin": "8.46.2",
+    "@typescript-eslint/parser": "8.46.2",
     "@vitest/coverage-v8": "3.2.4",
     "@vitest/eslint-plugin": "1.3.23",
     "eslint": "8.57.1",
     "eslint-plugin-import": "2.32.0",
     "glob": "11.0.3",
     "rimraf": "5.0.10",
-    "rollup": "4.52.4",
+    "rollup": "4.52.5",
     "typedoc": "0.28.14",
     "typescript": "5.9.3",
     "vitest": "3.2.4"