@jellyfin/sdk 0.10.0 → 0.12.0

package/lib/models/api/index.js

@@ -1 +1 @@
-export { ItemSortBy } from './item-sort-by.js';
+

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

package/lib/versions.js

@@ -4,8 +4,8 @@
  * 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.4';
+const API_VERSION = '10.11.0';
 /** The minimum supported server version. */
-const MINIMUM_VERSION = '10.9.0';
+const MINIMUM_VERSION = '10.10.0';
 
 export { API_VERSION, MINIMUM_VERSION };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jellyfin/sdk",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "A TypeScript SDK for Jellyfin.",
   "keywords": [
     "jellyfin"
@@ -22,26 +22,28 @@
     "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.4",
-    "@rollup/plugin-typescript": "11.1.6",
-    "@tsconfig/recommended": "1.0.6",
-    "@typescript-eslint/eslint-plugin": "7.3.1",
-    "@typescript-eslint/parser": "7.3.1",
-    "@vitest/coverage-v8": "1.6.0",
-    "eslint": "8.57.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-vitest": "0.3.26",
-    "glob": "10.4.1",
-    "rimraf": "5.0.7",
-    "rollup": "4.18.0",
-    "typedoc": "0.25.13",
-    "typescript": "5.4.5",
-    "vitest": "1.6.0"
+    "@openapitools/openapi-generator-cli": "2.25.0",
+    "@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",
+    "@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",
+    "typedoc": "0.28.14",
+    "typescript": "5.9.3",
+    "vitest": "3.2.4"
   },
   "peerDependencies": {
-    "axios": "^1.3.4"
+    "axios": "^1.12.0"
   }
 }

package/lib/models/api/item-sort-by.d.ts

@@ -1,40 +0,0 @@
-/**
- * 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/.
- */
-/**
- * An enum representing the item sort by options.
- * References: https://github.com/jellyfin/jellyfin/blob/master/MediaBrowser.Model/Querying/ItemSortBy.cs
- * @export
- * @enum {string}
- */
-export declare enum ItemSortBy {
-    AiredEpisodeOrder = "AiredEpisodeOrder",
-    AirTime = "AirTime",
-    Album = "Album",
-    AlbumArtist = "AlbumArtist",
-    Artist = "Artist",
-    CommunityRating = "CommunityRating",
-    CriticRating = "CriticRating",
-    DateCreated = "DateCreated",
-    DateLastContentAdded = "DateLastContentAdded",
-    DatePlayed = "DatePlayed",
-    IsFavoriteOrLiked = "IsFavoriteOrLiked",
-    IsFolder = "IsFolder",
-    IsPlayed = "IsPlayed",
-    IsUnplayed = "IsUnplayed",
-    Name = "Name",
-    OfficialRating = "OfficialRating",
-    PlayCount = "PlayCount",
-    PremiereDate = "PremiereDate",
-    ProductionYear = "ProductionYear",
-    Random = "Random",
-    Runtime = "Runtime",
-    SeriesDatePlayed = "SeriesDatePlayed",
-    SeriesSortName = "SeriesSortName",
-    SortName = "SortName",
-    StartDate = "StartDate",
-    Studio = "Studio",
-    VideoBitRate = "VideoBitRate"
-}

package/lib/models/api/item-sort-by.js

@@ -1,43 +0,0 @@
-/**
- * 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/.
- */
-/**
- * An enum representing the item sort by options.
- * References: https://github.com/jellyfin/jellyfin/blob/master/MediaBrowser.Model/Querying/ItemSortBy.cs
- * @export
- * @enum {string}
- */
-var ItemSortBy;
-(function (ItemSortBy) {
-    ItemSortBy["AiredEpisodeOrder"] = "AiredEpisodeOrder";
-    ItemSortBy["AirTime"] = "AirTime";
-    ItemSortBy["Album"] = "Album";
-    ItemSortBy["AlbumArtist"] = "AlbumArtist";
-    ItemSortBy["Artist"] = "Artist";
-    ItemSortBy["CommunityRating"] = "CommunityRating";
-    ItemSortBy["CriticRating"] = "CriticRating";
-    ItemSortBy["DateCreated"] = "DateCreated";
-    ItemSortBy["DateLastContentAdded"] = "DateLastContentAdded";
-    ItemSortBy["DatePlayed"] = "DatePlayed";
-    ItemSortBy["IsFavoriteOrLiked"] = "IsFavoriteOrLiked";
-    ItemSortBy["IsFolder"] = "IsFolder";
-    ItemSortBy["IsPlayed"] = "IsPlayed";
-    ItemSortBy["IsUnplayed"] = "IsUnplayed";
-    ItemSortBy["Name"] = "Name";
-    ItemSortBy["OfficialRating"] = "OfficialRating";
-    ItemSortBy["PlayCount"] = "PlayCount";
-    ItemSortBy["PremiereDate"] = "PremiereDate";
-    ItemSortBy["ProductionYear"] = "ProductionYear";
-    ItemSortBy["Random"] = "Random";
-    ItemSortBy["Runtime"] = "Runtime";
-    ItemSortBy["SeriesDatePlayed"] = "SeriesDatePlayed";
-    ItemSortBy["SeriesSortName"] = "SeriesSortName";
-    ItemSortBy["SortName"] = "SortName";
-    ItemSortBy["StartDate"] = "StartDate";
-    ItemSortBy["Studio"] = "Studio";
-    ItemSortBy["VideoBitRate"] = "VideoBitRate";
-})(ItemSortBy || (ItemSortBy = {}));
-
-export { ItemSortBy };