@jellyfin/sdk 0.9.0 → 0.11.0

package/lib/generated-client/models/trickplay-options.d.ts

@@ -8,8 +8,8 @@
  * 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 { ProcessPriorityClass } from './process-priority-class';
-import { TrickplayScanBehavior } from './trickplay-scan-behavior';
+import type { ProcessPriorityClass } from './process-priority-class';
+import type { TrickplayScanBehavior } from './trickplay-scan-behavior';
 /**
  * Class TrickplayOptions.
  * @export
@@ -28,6 +28,12 @@ export interface TrickplayOptions {
      * @memberof TrickplayOptions
      */
     'EnableHwEncoding'?: boolean;
+    /**
+     * Gets or sets a value indicating whether to only extract key frames.  Significantly faster, but is not compatible with all decoders and/or video files.
+     * @type {boolean}
+     * @memberof TrickplayOptions
+     */
+    'EnableKeyFrameOnlyExtraction'?: boolean;
     /**
      *
      * @type {TrickplayScanBehavior}

package/lib/generated-client/models/tuner-host-info.d.ts

@@ -56,6 +56,24 @@ export interface TunerHostInfo {
      * @memberof TunerHostInfo
      */
     'AllowHWTranscoding'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof TunerHostInfo
+     */
+    'AllowFmp4TranscodingContainer'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof TunerHostInfo
+     */
+    'AllowStreamSharing'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof TunerHostInfo
+     */
+    'FallbackMaxStreamingBitrate'?: number;
     /**
      *
      * @type {boolean}

package/lib/generated-client/models/type-options.d.ts

@@ -8,7 +8,7 @@
  * 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 { ImageOption } from './image-option';
+import type { ImageOption } from './image-option';
 /**
  *
  * @export

package/lib/generated-client/models/update-library-options-dto.d.ts

@@ -8,7 +8,7 @@
  * 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 { LibraryOptions } from './library-options';
+import type { LibraryOptions } from './library-options';
 /**
  * Update library options dto.
  * @export

package/lib/generated-client/models/update-media-path-request-dto.d.ts

@@ -8,7 +8,7 @@
  * 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 { MediaPathInfo } from './media-path-info';
+import type { MediaPathInfo } from './media-path-info';
 /**
  * Update library options dto.
  * @export

package/lib/generated-client/models/update-playlist-dto.d.ts

@@ -8,7 +8,7 @@
  * 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 { PlaylistUserPermissions } from './playlist-user-permissions';
+import type { PlaylistUserPermissions } from './playlist-user-permissions';
 /**
  * Update existing playlist dto. Fields set to `null` will not be updated and keep their current values.
  * @export

package/lib/generated-client/models/user-configuration.d.ts

@@ -8,7 +8,7 @@
  * 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 { SubtitlePlaybackMode } from './subtitle-playback-mode';
+import type { SubtitlePlaybackMode } from './subtitle-playback-mode';
 /**
  * Class UserConfiguration.
  * @export

package/lib/generated-client/models/user-data-change-info.d.ts

@@ -8,7 +8,7 @@
  * 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 { UserItemDataDto } from './user-item-data-dto';
+import type { UserItemDataDto } from './user-item-data-dto';
 /**
  * Class UserDataChangeInfo.
  * @export
@@ -20,11 +20,11 @@ export interface UserDataChangeInfo {
      * @type {string}
      * @memberof UserDataChangeInfo
      */
-    'UserId'?: string | null;
+    'UserId'?: string;
     /**
      * Gets or sets the user data list.
      * @type {Array<UserItemDataDto>}
      * @memberof UserDataChangeInfo
      */
-    'UserDataList'?: Array<UserItemDataDto> | null;
+    'UserDataList'?: Array<UserItemDataDto>;
 }

package/lib/generated-client/models/user-data-changed-message.d.ts

@@ -8,8 +8,8 @@
  * 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 { SessionMessageType } from './session-message-type';
-import { UserDataChangeInfo } from './user-data-change-info';
+import type { SessionMessageType } from './session-message-type';
+import type { UserDataChangeInfo } from './user-data-change-info';
 /**
  * User data changed message.
  * @export

package/lib/generated-client/models/user-deleted-message.d.ts

@@ -8,7 +8,7 @@
  * 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 { SessionMessageType } from './session-message-type';
+import type { SessionMessageType } from './session-message-type';
 /**
  * User deleted message.
  * @export

package/lib/generated-client/models/user-dto.d.ts

@@ -8,8 +8,8 @@
  * 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 { UserConfiguration } from './user-configuration';
-import { UserPolicy } from './user-policy';
+import type { UserConfiguration } from './user-configuration';
+import type { UserPolicy } from './user-policy';
 /**
  * Class UserDto.
  * @export

package/lib/generated-client/models/user-item-data-dto.d.ts

@@ -73,11 +73,11 @@ export interface UserItemDataDto {
      * @type {string}
      * @memberof UserItemDataDto
      */
-    'Key'?: string | null;
+    'Key'?: string;
     /**
      * Gets or sets the item identifier.
      * @type {string}
      * @memberof UserItemDataDto
      */
-    'ItemId'?: string | null;
+    'ItemId'?: string;
 }

package/lib/generated-client/models/user-policy.d.ts

@@ -8,9 +8,9 @@
  * 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 { AccessSchedule } from './access-schedule';
-import { SyncPlayUserAccessType } from './sync-play-user-access-type';
-import { UnratedItem } from './unrated-item';
+import type { AccessSchedule } from './access-schedule';
+import type { SyncPlayUserAccessType } from './sync-play-user-access-type';
+import type { UnratedItem } from './unrated-item';
 /**
  *
  * @export

package/lib/generated-client/models/user-updated-message.d.ts

@@ -8,8 +8,8 @@
  * 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 { SessionMessageType } from './session-message-type';
-import { UserDto } from './user-dto';
+import type { SessionMessageType } from './session-message-type';
+import type { UserDto } from './user-dto';
 /**
  * User updated message.
  * @export

package/lib/generated-client/models/virtual-folder-info.d.ts

@@ -8,8 +8,8 @@
  * 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 { CollectionTypeOptions } from './collection-type-options';
-import { LibraryOptions } from './library-options';
+import type { CollectionTypeOptions } from './collection-type-options';
+import type { LibraryOptions } from './library-options';
 /**
  * Used to hold information about a user\'s list of configured virtual folders.
  * @export

package/lib/generated-client/models/web-socket-message.d.ts

@@ -8,8 +8,8 @@
  * 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 { InboundWebSocketMessage } from './inbound-web-socket-message';
-import { OutboundWebSocketMessage } from './outbound-web-socket-message';
+import type { InboundWebSocketMessage } from './inbound-web-socket-message';
+import type { OutboundWebSocketMessage } from './outbound-web-socket-message';
 /**
  * @type WebSocketMessage
  * Represents the possible websocket types

package/lib/utils/address-candidates.js

@@ -1,5 +1,5 @@
-import { parseUrl, copyUrl, getDefaultPort } from './url/index.js';
-import { HTTP_PROTOCOL, HTTPS_PROTOCOL, HTTPS_PORT, HTTP_PORT } from './url/constants.js';
+import { parseUrl, hasProtocolAndPort, copyUrl, isDefaultPort } from './url/index.js';
+import { HTTP_PROTOCOL, HTTPS_PROTOCOL } from './url/constants.js';
 
 /**
  * This Source Code Form is subject to the terms of the Mozilla Public
@@ -31,10 +31,7 @@ function getScore(url) {
         score -= 1; // Using the Jellyfin https port is not common
     }
     // Prefer default ports for http(s) protocols
-    if (url.protocol === HTTPS_PROTOCOL && (!url.port || url.port === HTTPS_PORT.toString())) {
-        score += 3;
-    }
-    else if (url.protocol === HTTP_PROTOCOL && (!url.port || url.port === HTTP_PORT.toString())) {
+    if (isDefaultPort(url)) {
         score += 3;
     }
     return score;
@@ -49,14 +46,21 @@ function getAddressCandidates(input) {
     const candidates = [];
     try {
         const url = parseUrl(input);
+        // If the input specifies the protocol and port return it directly
+        if (hasProtocolAndPort(input, url)) {
+            return [url.toString()];
+        }
+        // Add the parsed url as a candidate
         candidates.push(url);
+        // Always try https if http is specified
         if (url.protocol === HTTP_PROTOCOL) {
             const copy = copyUrl(url);
             copy.protocol = HTTPS_PROTOCOL;
             candidates.push(copy);
         }
+        // Add candidates with JF default ports for candidates using the protocol default port
         candidates
-            .filter(val => !val.port || val.port === getDefaultPort(val.protocol).toString())
+            .filter(isDefaultPort)
             .forEach(val => {
             if (val.protocol === HTTP_PROTOCOL) {
                 const copy = copyUrl(val);
@@ -72,9 +76,10 @@ function getAddressCandidates(input) {
                 candidates.push(copy);
             }
         });
-        return candidates
-            .sort((a, b) => getScore(b) - getScore(a))
-            .map(candidate => candidate.toString());
+        // Sort by score
+        candidates.sort((a, b) => getScore(b) - getScore(a));
+        // Return the list of candidate urls as strings
+        return candidates.map(candidate => candidate.toString());
     }
     catch (err) {
         console.warn(err);

package/lib/utils/api/image-urls-api.js

@@ -40,7 +40,10 @@ class ImageUrlsApi extends ImageApi {
         var _a, _b;
         if (!(item === null || item === void 0 ? void 0 : item.Id))
             return;
-        return this.getItemImageUrlById(item.Id, imageType, Object.assign(Object.assign({}, params), { tag: (_a = params.tag) !== null && _a !== void 0 ? _a : (_b = item.ImageTags) === null || _b === void 0 ? void 0 : _b[imageType] }));
+        return this.getItemImageUrlById(item.Id, imageType, {
+            ...params,
+            tag: (_a = params.tag) !== null && _a !== void 0 ? _a : (_b = item.ImageTags) === null || _b === void 0 ? void 0 : _b[imageType]
+        });
     }
     /**
      * Get an Item's backdrop image URLs.
@@ -55,7 +58,10 @@ class ImageUrlsApi extends ImageApi {
         if (!id)
             return urls;
         (_a = item.BackdropImageTags) === null || _a === void 0 ? void 0 : _a.forEach(tag => {
-            const url = this.getItemImageUrlById(id, ImageType.Backdrop, Object.assign(Object.assign({}, params), { tag }));
+            const url = this.getItemImageUrlById(id, ImageType.Backdrop, {
+                ...params,
+                tag
+            });
             urls.push(url);
         });
         if (urls.length > 0)
@@ -63,7 +69,10 @@ class ImageUrlsApi extends ImageApi {
         const parentId = item.ParentBackdropItemId;
         if (parentId) {
             (_b = item.ParentBackdropImageTags) === null || _b === void 0 ? void 0 : _b.forEach(tag => {
-                const url = this.getItemImageUrlById(parentId, ImageType.Backdrop, Object.assign(Object.assign({}, params), { tag }));
+                const url = this.getItemImageUrlById(parentId, ImageType.Backdrop, {
+                    ...params,
+                    tag
+                });
                 urls.push(url);
             });
         }
@@ -95,7 +104,10 @@ class ImageUrlsApi extends ImageApi {
         return this.axios.getUri({
             baseURL: (_a = this.configuration) === null || _a === void 0 ? void 0 : _a.basePath,
             url: `/Users/${user.Id}/Images/Primary`,
-            params: Object.assign(Object.assign({}, params), { tag: user.PrimaryImageTag })
+            params: {
+                ...params,
+                tag: user.PrimaryImageTag
+            }
         });
     }
 }

package/lib/utils/api/index.d.ts

@@ -32,6 +32,7 @@ export * from './live-tv-api';
 export * from './localization-api';
 export * from './lyrics-api';
 export * from './media-info-api';
+export * from './media-segments-api';
 export * from './movies-api';
 export * from './music-genres-api';
 export * from './package-api';

package/lib/utils/api/index.js

@@ -27,6 +27,7 @@ export { getLiveTvApi } from './live-tv-api.js';
 export { getLocalizationApi } from './localization-api.js';
 export { getLyricsApi } from './lyrics-api.js';
 export { getMediaInfoApi } from './media-info-api.js';
+export { getMediaSegmentsApi } from './media-segments-api.js';
 export { getMoviesApi } from './movies-api.js';
 export { getMusicGenresApi } from './music-genres-api.js';
 export { getPackageApi } from './package-api.js';

package/lib/utils/api/media-segments-api.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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/.
+ */
+import type { Api } from '../../api';
+import { MediaSegmentsApi } from '../../generated-client/api/media-segments-api';
+export declare function getMediaSegmentsApi(api: Api): MediaSegmentsApi;

package/lib/utils/api/media-segments-api.js

@@ -0,0 +1,12 @@
+import { MediaSegmentsApi } from '../../generated-client/api/media-segments-api.js';
+
+/**
+ * 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/.
+ */
+function getMediaSegmentsApi(api) {
+    return new MediaSegmentsApi(api.configuration, undefined, api.axiosInstance);
+}
+
+export { getMediaSegmentsApi };

package/lib/utils/index.js

@@ -1,7 +1,7 @@
 export { JF_HTTPS_PORT, JF_HTTP_PORT, getAddressCandidates } from './address-candidates.js';
 export { getAuthorizationHeader } from './authentication.js';
 export { getBrowserDeviceProfile } from './browser-profiles.js';
-export { copyUrl, getDefaultPort, parseUrl } from './url/index.js';
+export { copyUrl, getDefaultPort, hasProtocolAndPort, isDefaultPort, parseUrl } from './url/index.js';
 export { isVersionLess } from './versioning.js';
 export { HTTPS_PORT, HTTPS_PROTOCOL, HTTP_PORT, HTTP_PROTOCOL } from './url/constants.js';
 

package/lib/utils/url/index.d.ts

@@ -18,8 +18,21 @@ export declare function copyUrl(original: URL): URL;
  */
 export declare function getDefaultPort(protocol: string): number;
 /**
- * Parses a string to a Url object.
- * @param input A string representing a url.
- * @returns The Url object.
+ * Checks if the URL string specifies the protocol and port.
+ * @param urlString The URL string to test.
+ * @param url The parsed URL object.
+ * @returns True if the the URL string includes the protocol and port.
+ */
+export declare function hasProtocolAndPort(urlString: string, url: URL): boolean;
+/**
+ * Checks if the URL is using the protocol's default port.
+ * @param url The URL object to check.
+ * @returns True if the URL port is the protocol default.
+ */
+export declare function isDefaultPort(url: URL): boolean;
+/**
+ * Parses a string to a URL object.
+ * @param input A string representing a URL.
+ * @returns The URL object.
  */
 export declare function parseUrl(input: string): URL;

package/lib/utils/url/index.js

@@ -27,9 +27,31 @@ function getDefaultPort(protocol) {
     throw new Error('Unsupported protocol');
 }
 /**
- * Parses a string to a Url object.
- * @param input A string representing a url.
- * @returns The Url object.
+ * Checks if the URL string specifies the protocol and port.
+ * @param urlString The URL string to test.
+ * @param url The parsed URL object.
+ * @returns True if the the URL string includes the protocol and port.
+ */
+function hasProtocolAndPort(urlString, url) {
+    // The parsed URL object drops the default port
+    const port = url.port || getDefaultPort(url.protocol);
+    return urlString
+        .toLowerCase()
+        .startsWith(`${url.protocol}//${url.hostname.toLowerCase()}:${port}`);
+}
+/**
+ * Checks if the URL is using the protocol's default port.
+ * @param url The URL object to check.
+ * @returns True if the URL port is the protocol default.
+ */
+function isDefaultPort(url) {
+    return !url.port
+        || (url.port === getDefaultPort(url.protocol).toString());
+}
+/**
+ * Parses a string to a URL object.
+ * @param input A string representing a URL.
+ * @returns The URL object.
  */
 function parseUrl(input) {
     if (!(input === null || input === void 0 ? void 0 : input.trim())) {
@@ -38,4 +60,4 @@ function parseUrl(input) {
     return new URL(normalizeUrl(input));
 }
 
-export { HTTPS_PORT, HTTPS_PROTOCOL, HTTP_PORT, HTTP_PROTOCOL, copyUrl, getDefaultPort, parseUrl };
+export { HTTPS_PORT, HTTPS_PROTOCOL, HTTP_PORT, HTTP_PROTOCOL, copyUrl, getDefaultPort, hasProtocolAndPort, isDefaultPort, parseUrl };

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.9.1";
+export declare const API_VERSION = "10.10.0";
 /** The minimum supported server version. */
 export declare const MINIMUM_VERSION = "10.9.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.9.1';
+const API_VERSION = '10.10.0';
 /** The minimum supported server version. */
 const MINIMUM_VERSION = '10.9.0';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jellyfin/sdk",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "A TypeScript SDK for Jellyfin.",
   "keywords": [
     "jellyfin"
@@ -22,24 +22,25 @@
     "fix-schema": "node scripts/modify-schema.mjs openapi.json",
     "lint": "eslint \".\"",
     "prepublishOnly": "npm run clean:build:sdk",
-    "test": "vitest --exclude **/integration.test.ts"
+    "test": "vitest --exclude **/integration.test.ts",
+    "test:integration": "vitest integration"
   },
   "devDependencies": {
-    "@openapitools/openapi-generator-cli": "2.13.1",
-    "@rollup/plugin-typescript": "11.1.6",
-    "@tsconfig/recommended": "1.0.4",
+    "@openapitools/openapi-generator-cli": "2.14.1",
+    "@rollup/plugin-typescript": "12.1.1",
+    "@tsconfig/recommended": "1.0.7",
     "@typescript-eslint/eslint-plugin": "7.3.1",
     "@typescript-eslint/parser": "7.3.1",
-    "@vitest/coverage-v8": "1.4.0",
+    "@vitest/coverage-v8": "2.1.3",
     "eslint": "8.57.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-vitest": "0.3.26",
-    "glob": "10.3.10",
-    "rimraf": "5.0.5",
-    "rollup": "4.13.0",
-    "typedoc": "0.25.12",
-    "typescript": "5.4.3",
-    "vitest": "1.4.0"
+    "glob": "11.0.0",
+    "rimraf": "5.0.10",
+    "rollup": "4.24.0",
+    "typedoc": "0.26.10",
+    "typescript": "5.6.3",
+    "vitest": "2.1.3"
   },
   "peerDependencies": {
     "axios": "^1.3.4"

package/lib/node_modules/tslib/tslib.es6.js

@@ -1,33 +0,0 @@
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
-
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
-export { __awaiter };