@jellyfin/sdk 0.0.0-unstable.202512080502 → 0.0.0-unstable.202512091852

package/CHANGELOG.md

@@ -7,6 +7,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## [Unreleased]
 
+### Added
+
+* `getLibraryApi` now returns an augmented class with a `getDownloadUrl` method ([#967](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/967)).
+
 ## [0.13.0] - 2025-10-28
 
 ### Changed
@@ -15,7 +19,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ### Deprecated
 
-* Deprecate authentication helper methods in `Api` class ([#949](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/948)).
+* Deprecate authentication helper methods in `Api` class ([#949](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/949)).
   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.
 

package/lib/api.d.ts

@@ -9,6 +9,8 @@ import type { AuthenticationResult } from './generated-client/models/authenticat
 import type { ClientInfo, DeviceInfo } from './models';
 /** The authorization header field name. */
 export declare const AUTHORIZATION_HEADER = "Authorization";
+/** The authorization query parameter name. */
+export declare const AUTHORIZATION_PARAMETER = "ApiKey";
 /** Class representing the Jellyfin API. */
 export declare class Api {
     basePath: string;

package/lib/api.js

@@ -6,6 +6,8 @@ import { getUserApi } from './utils/api/user-api.js';
 
 /** The authorization header field name. */
 const AUTHORIZATION_HEADER = 'Authorization';
+/** The authorization query parameter name. */
+const AUTHORIZATION_PARAMETER = 'ApiKey';
 /** Class representing the Jellyfin API. */
 class Api {
     constructor(basePath, clientInfo, deviceInfo, accessToken = '', axiosInstance = globalAxios) {
@@ -62,4 +64,4 @@ class Api {
     }
 }
 
-export { AUTHORIZATION_HEADER, Api };
+export { AUTHORIZATION_HEADER, AUTHORIZATION_PARAMETER, Api };

package/lib/generated-client/api/activity-log-api.d.ts

@@ -12,6 +12,9 @@ import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
 import type { ActivityLogEntryQueryResult } from '../models';
+import type { ActivityLogSortBy } from '../models';
+import type { LogLevel } from '../models';
+import type { SortOrder } from '../models';
 /**
  * ActivityLogApi - axios parameter creator
  * @export
@@ -20,14 +23,23 @@ export declare const ActivityLogApiAxiosParamCreator: (configuration?: Configura
     /**
      *
      * @summary Gets activity log entries.
-     * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
-     * @param {number} [limit] Optional. The maximum number of records to return.
-     * @param {string} [minDate] Optional. The minimum date. Format = ISO.
-     * @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
+     * @param {number} [startIndex] The record index to start at. All items with a lower index will be dropped from the results.
+     * @param {number} [limit] The maximum number of records to return.
+     * @param {string} [minDate] The minimum date.
+     * @param {boolean} [hasUserId] Filter log entries if it has user id, or not.
+     * @param {string} [name] Filter by name.
+     * @param {string} [overview] Filter by overview.
+     * @param {string} [shortOverview] Filter by short overview.
+     * @param {string} [type] Filter by type.
+     * @param {string} [itemId] Filter by item id.
+     * @param {string} [username] Filter by username.
+     * @param {LogLevel} [severity] Filter by log severity.
+     * @param {Array<ActivityLogSortBy>} [sortBy] Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
+     * @param {Array<SortOrder>} [sortOrder] Sort Order..
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, name?: string, overview?: string, shortOverview?: string, type?: string, itemId?: string, username?: string, severity?: LogLevel, sortBy?: Array<ActivityLogSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ActivityLogApi - functional programming interface
@@ -37,14 +49,23 @@ export declare const ActivityLogApiFp: (configuration?: Configuration) => {
     /**
      *
      * @summary Gets activity log entries.
-     * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
-     * @param {number} [limit] Optional. The maximum number of records to return.
-     * @param {string} [minDate] Optional. The minimum date. Format &#x3D; ISO.
-     * @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
+     * @param {number} [startIndex] The record index to start at. All items with a lower index will be dropped from the results.
+     * @param {number} [limit] The maximum number of records to return.
+     * @param {string} [minDate] The minimum date.
+     * @param {boolean} [hasUserId] Filter log entries if it has user id, or not.
+     * @param {string} [name] Filter by name.
+     * @param {string} [overview] Filter by overview.
+     * @param {string} [shortOverview] Filter by short overview.
+     * @param {string} [type] Filter by type.
+     * @param {string} [itemId] Filter by item id.
+     * @param {string} [username] Filter by username.
+     * @param {LogLevel} [severity] Filter by log severity.
+     * @param {Array<ActivityLogSortBy>} [sortBy] Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
+     * @param {Array<SortOrder>} [sortOrder] Sort Order..
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>;
+    getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, name?: string, overview?: string, shortOverview?: string, type?: string, itemId?: string, username?: string, severity?: LogLevel, sortBy?: Array<ActivityLogSortBy>, sortOrder?: Array<SortOrder>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>;
 };
 /**
  * ActivityLogApi - factory interface
@@ -67,29 +88,83 @@ export declare const ActivityLogApiFactory: (configuration?: Configuration, base
  */
 export interface ActivityLogApiGetLogEntriesRequest {
     /**
-     * Optional. The record index to start at. All items with a lower index will be dropped from the results.
+     * The record index to start at. All items with a lower index will be dropped from the results.
      * @type {number}
      * @memberof ActivityLogApiGetLogEntries
      */
     readonly startIndex?: number;
     /**
-     * Optional. The maximum number of records to return.
+     * The maximum number of records to return.
      * @type {number}
      * @memberof ActivityLogApiGetLogEntries
      */
     readonly limit?: number;
     /**
-     * Optional. The minimum date. Format &#x3D; ISO.
+     * The minimum date.
      * @type {string}
      * @memberof ActivityLogApiGetLogEntries
      */
     readonly minDate?: string;
     /**
-     * Optional. Filter log entries if it has user id, or not.
+     * Filter log entries if it has user id, or not.
      * @type {boolean}
      * @memberof ActivityLogApiGetLogEntries
      */
     readonly hasUserId?: boolean;
+    /**
+     * Filter by name.
+     * @type {string}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly name?: string;
+    /**
+     * Filter by overview.
+     * @type {string}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly overview?: string;
+    /**
+     * Filter by short overview.
+     * @type {string}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly shortOverview?: string;
+    /**
+     * Filter by type.
+     * @type {string}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly type?: string;
+    /**
+     * Filter by item id.
+     * @type {string}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly itemId?: string;
+    /**
+     * Filter by username.
+     * @type {string}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly username?: string;
+    /**
+     * Filter by log severity.
+     * @type {LogLevel}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly severity?: LogLevel;
+    /**
+     * Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
+     * @type {Array<ActivityLogSortBy>}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly sortBy?: Array<ActivityLogSortBy>;
+    /**
+     * Sort Order..
+     * @type {Array<SortOrder>}
+     * @memberof ActivityLogApiGetLogEntries
+     */
+    readonly sortOrder?: Array<SortOrder>;
 }
 /**
  * ActivityLogApi - object-oriented interface

package/lib/generated-client/api/activity-log-api.js

@@ -23,14 +23,23 @@ const ActivityLogApiAxiosParamCreator = function (configuration) {
         /**
          *
          * @summary Gets activity log entries.
-         * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
-         * @param {number} [limit] Optional. The maximum number of records to return.
-         * @param {string} [minDate] Optional. The minimum date. Format = ISO.
-         * @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
+         * @param {number} [startIndex] The record index to start at. All items with a lower index will be dropped from the results.
+         * @param {number} [limit] The maximum number of records to return.
+         * @param {string} [minDate] The minimum date.
+         * @param {boolean} [hasUserId] Filter log entries if it has user id, or not.
+         * @param {string} [name] Filter by name.
+         * @param {string} [overview] Filter by overview.
+         * @param {string} [shortOverview] Filter by short overview.
+         * @param {string} [type] Filter by type.
+         * @param {string} [itemId] Filter by item id.
+         * @param {string} [username] Filter by username.
+         * @param {LogLevel} [severity] Filter by log severity.
+         * @param {Array<ActivityLogSortBy>} [sortBy] Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
+         * @param {Array<SortOrder>} [sortOrder] Sort Order..
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLogEntries: async (startIndex, limit, minDate, hasUserId, options = {}) => {
+        getLogEntries: async (startIndex, limit, minDate, hasUserId, name, overview, shortOverview, type, itemId, username, severity, sortBy, sortOrder, options = {}) => {
             const localVarPath = `/System/ActivityLog/Entries`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -57,6 +66,33 @@ const ActivityLogApiAxiosParamCreator = function (configuration) {
             if (hasUserId !== undefined) {
                 localVarQueryParameter['hasUserId'] = hasUserId;
             }
+            if (name !== undefined) {
+                localVarQueryParameter['name'] = name;
+            }
+            if (overview !== undefined) {
+                localVarQueryParameter['overview'] = overview;
+            }
+            if (shortOverview !== undefined) {
+                localVarQueryParameter['shortOverview'] = shortOverview;
+            }
+            if (type !== undefined) {
+                localVarQueryParameter['type'] = type;
+            }
+            if (itemId !== undefined) {
+                localVarQueryParameter['itemId'] = itemId;
+            }
+            if (username !== undefined) {
+                localVarQueryParameter['username'] = username;
+            }
+            if (severity !== undefined) {
+                localVarQueryParameter['severity'] = severity;
+            }
+            if (sortBy) {
+                localVarQueryParameter['sortBy'] = sortBy;
+            }
+            if (sortOrder) {
+                localVarQueryParameter['sortOrder'] = sortOrder;
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -77,16 +113,25 @@ const ActivityLogApiFp = function (configuration) {
         /**
          *
          * @summary Gets activity log entries.
-         * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
-         * @param {number} [limit] Optional. The maximum number of records to return.
-         * @param {string} [minDate] Optional. The minimum date. Format &#x3D; ISO.
-         * @param {boolean} [hasUserId] Optional. Filter log entries if it has user id, or not.
+         * @param {number} [startIndex] The record index to start at. All items with a lower index will be dropped from the results.
+         * @param {number} [limit] The maximum number of records to return.
+         * @param {string} [minDate] The minimum date.
+         * @param {boolean} [hasUserId] Filter log entries if it has user id, or not.
+         * @param {string} [name] Filter by name.
+         * @param {string} [overview] Filter by overview.
+         * @param {string} [shortOverview] Filter by short overview.
+         * @param {string} [type] Filter by type.
+         * @param {string} [itemId] Filter by item id.
+         * @param {string} [username] Filter by username.
+         * @param {LogLevel} [severity] Filter by log severity.
+         * @param {Array<ActivityLogSortBy>} [sortBy] Specify one or more sort orders. Format: SortBy&#x3D;Name,Type.
+         * @param {Array<SortOrder>} [sortOrder] Sort Order..
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getLogEntries(startIndex, limit, minDate, hasUserId, options) {
+        async getLogEntries(startIndex, limit, minDate, hasUserId, name, overview, shortOverview, type, itemId, username, severity, sortBy, sortOrder, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getLogEntries(startIndex, limit, minDate, hasUserId, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLogEntries(startIndex, limit, minDate, hasUserId, name, overview, shortOverview, type, itemId, username, severity, sortBy, sortOrder, options);
             const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
             const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ActivityLogApi.getLogEntries']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -108,7 +153,7 @@ const ActivityLogApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getLogEntries(requestParameters = {}, options) {
-            return localVarFp.getLogEntries(requestParameters.startIndex, requestParameters.limit, requestParameters.minDate, requestParameters.hasUserId, options).then((request) => request(axios, basePath));
+            return localVarFp.getLogEntries(requestParameters.startIndex, requestParameters.limit, requestParameters.minDate, requestParameters.hasUserId, requestParameters.name, requestParameters.overview, requestParameters.shortOverview, requestParameters.type, requestParameters.itemId, requestParameters.username, requestParameters.severity, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -128,7 +173,7 @@ class ActivityLogApi extends BaseAPI {
      * @memberof ActivityLogApi
      */
     getLogEntries(requestParameters = {}, options) {
-        return ActivityLogApiFp(this.configuration).getLogEntries(requestParameters.startIndex, requestParameters.limit, requestParameters.minDate, requestParameters.hasUserId, options).then((request) => request(this.axios, this.basePath));
+        return ActivityLogApiFp(this.configuration).getLogEntries(requestParameters.startIndex, requestParameters.limit, requestParameters.minDate, requestParameters.hasUserId, requestParameters.name, requestParameters.overview, requestParameters.shortOverview, requestParameters.type, requestParameters.itemId, requestParameters.username, requestParameters.severity, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath));
     }
 }
 

package/lib/generated-client/index.js

@@ -60,6 +60,7 @@ export { VideoAttachmentsApi, VideoAttachmentsApiAxiosParamCreator, VideoAttachm
 export { VideosApi, VideosApiAxiosParamCreator, VideosApiFactory, VideosApiFp } from './api/videos-api.js';
 export { YearsApi, YearsApiAxiosParamCreator, YearsApiFactory, YearsApiFp } from './api/years-api.js';
 export { Configuration } from './configuration.js';
+export { ActivityLogSortBy } from './models/activity-log-sort-by.js';
 export { AudioSpatialFormat } from './models/audio-spatial-format.js';
 export { BaseItemKind } from './models/base-item-kind.js';
 export { ChannelItemSortField } from './models/channel-item-sort-field.js';

package/lib/generated-client/models/activity-log-sort-by.d.ts

@@ -0,0 +1,25 @@
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * 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/.
+ */
+/**
+ * Activity log sorting options.
+ * @export
+ * @enum {string}
+ */
+export declare const ActivityLogSortBy: {
+    readonly Name: "Name";
+    readonly Overiew: "Overiew";
+    readonly ShortOverview: "ShortOverview";
+    readonly Type: "Type";
+    readonly DateCreated: "DateCreated";
+    readonly Username: "Username";
+    readonly LogSeverity: "LogSeverity";
+};
+export type ActivityLogSortBy = typeof ActivityLogSortBy[keyof typeof ActivityLogSortBy];

package/lib/generated-client/models/activity-log-sort-by.js

@@ -0,0 +1,28 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * Do not edit the class manually.
+ *
+ * Jellyfin API
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * 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/.
+ */
+/**
+ * Activity log sorting options.
+ * @export
+ * @enum {string}
+ */
+const ActivityLogSortBy = {
+    Name: 'Name',
+    Overiew: 'Overiew',
+    ShortOverview: 'ShortOverview',
+    Type: 'Type',
+    DateCreated: 'DateCreated',
+    Username: 'Username',
+    LogSeverity: 'LogSeverity'
+};
+
+export { ActivityLogSortBy };

package/lib/generated-client/models/index.d.ts

@@ -4,6 +4,7 @@ export * from './activity-log-entry-message';
 export * from './activity-log-entry-query-result';
 export * from './activity-log-entry-start-message';
 export * from './activity-log-entry-stop-message';
+export * from './activity-log-sort-by';
 export * from './add-virtual-folder-dto';
 export * from './album-info';
 export * from './album-info-remote-search-query';

package/lib/generated-client/models/index.js

@@ -1,3 +1,4 @@
+export { ActivityLogSortBy } from './activity-log-sort-by.js';
 export { AudioSpatialFormat } from './audio-spatial-format.js';
 export { BaseItemKind } from './base-item-kind.js';
 export { ChannelItemSortField } from './channel-item-sort-field.js';

package/lib/index.js

@@ -2,7 +2,7 @@ import * as discovery_index from './discovery/index.js';
 export { discovery_index as discovery };
 import * as utils_index from './utils/index.js';
 export { utils_index as utils };
-export { AUTHORIZATION_HEADER, Api } from './api.js';
+export { AUTHORIZATION_HEADER, AUTHORIZATION_PARAMETER, Api } from './api.js';
 export { Jellyfin } from './jellyfin.js';
 export { RecommendedServerInfoScore } from './models/recommended-server-info.js';
 export { ProductNameIssue, RecommendedServerIssue, SlowResponseIssue, SystemInfoIssue, VersionMissingIssue, VersionOutdatedIssue, VersionUnsupportedIssue } from './models/recommended-server-issue.js';

package/lib/utils/api/library-api.d.ts

@@ -3,6 +3,18 @@
  * 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/.
  */
-import type { Api } from '../../api';
-import { LibraryApi } from '../../generated-client/api/library-api';
-export declare function getLibraryApi(api: Api): LibraryApi;
+import { type Api } from '../../api';
+import { LibraryApi, type LibraryApiGetDownloadRequest } from '../../generated-client/api/library-api';
+/** An augmented LibraryApi with URL helpers. */
+declare class AugmentedLibraryApi extends LibraryApi {
+    api: Api;
+    constructor(api: Api);
+    /**
+     * Get an Item download URL.
+     * @param requestParameters The download request parameters.
+     * @returns The Item download URL.
+     */
+    getDownloadUrl(requestParameters: LibraryApiGetDownloadRequest): string;
+}
+export declare function getLibraryApi(api: Api): AugmentedLibraryApi;
+export {};

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

@@ -1,3 +1,4 @@
+import { AUTHORIZATION_PARAMETER } from '../../api.js';
 import { LibraryApi } from '../../generated-client/api/library-api.js';
 
 /**
@@ -5,8 +6,23 @@ import { LibraryApi } from '../../generated-client/api/library-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 LibraryApi with URL helpers. */
+class AugmentedLibraryApi extends LibraryApi {
+    constructor(api) {
+        super(api.configuration, undefined, api.axiosInstance);
+        this.api = api;
+    }
+    /**
+     * Get an Item download URL.
+     * @param requestParameters The download request parameters.
+     * @returns The Item download URL.
+     */
+    getDownloadUrl(requestParameters) {
+        return this.api.getUri(`/Items/${requestParameters.itemId}/Download`, { [AUTHORIZATION_PARAMETER]: this.api.accessToken });
+    }
+}
 function getLibraryApi(api) {
-    return new LibraryApi(api.configuration, undefined, api.axiosInstance);
+    return new AugmentedLibraryApi(api);
 }
 
 export { getLibraryApi };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jellyfin/sdk",
-  "version": "0.0.0-unstable.202512080502+commit.324e5ae9ab4ddfda7a1fded470d056ccf69e9934",
+  "version": "0.0.0-unstable.202512091852+commit.b1c8b8d74a21b64230f76e1db7b7120704869e3f",
   "description": "A TypeScript SDK for Jellyfin.",
   "keywords": [
     "jellyfin"