@jellyfin/sdk 0.8.2 → 0.10.0

package/lib/utils/api/index.js

@@ -10,15 +10,12 @@ export { getConfigurationApi } from './configuration-api.js';
 export { getDashboardApi } from './dashboard-api.js';
 export { getDevicesApi } from './devices-api.js';
 export { getDisplayPreferencesApi } from './display-preferences-api.js';
-export { getDlnaApi } from './dlna-api.js';
-export { getDlnaServerApi } from './dlna-server-api.js';
 export { getDynamicHlsApi } from './dynamic-hls-api.js';
 export { getEnvironmentApi } from './environment-api.js';
 export { getFilterApi } from './filter-api.js';
 export { getGenresApi } from './genres-api.js';
 export { getHlsSegmentApi } from './hls-segment-api.js';
 export { getImageApi } from './image-api.js';
-export { getImageByNameApi } from './image-by-name-api.js';
 export { getInstantMixApi } from './instant-mix-api.js';
 export { getItemLookupApi } from './item-lookup-api.js';
 export { getItemRefreshApi } from './item-refresh-api.js';
@@ -28,10 +25,10 @@ export { getLibraryApi } from './library-api.js';
 export { getLibraryStructureApi } from './library-structure-api.js';
 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 { getMoviesApi } from './movies-api.js';
 export { getMusicGenresApi } from './music-genres-api.js';
-export { getNotificationsApi } from './notifications-api.js';
 export { getPackageApi } from './package-api.js';
 export { getPersonsApi } from './persons-api.js';
 export { getPlaylistsApi } from './playlists-api.js';
@@ -51,6 +48,7 @@ export { getSystemApi } from './system-api.js';
 export { getTimeSyncApi } from './time-sync-api.js';
 export { getTmdbApi } from './tmdb-api.js';
 export { getTrailersApi } from './trailers-api.js';
+export { getTrickplayApi } from './trickplay-api.js';
 export { getTvShowsApi } from './tv-shows-api.js';
 export { getUniversalAudioApi } from './universal-audio-api.js';
 export { getUserApi } from './user-api.js';

package/lib/utils/api/{dlna-api.d.ts → lyrics-api.d.ts}

@@ -4,5 +4,5 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 import type { Api } from '../../api';
-import { DlnaApi } from '../../generated-client/api/dlna-api';
-export declare function getDlnaApi(api: Api): DlnaApi;
+import { LyricsApi } from '../../generated-client/api/lyrics-api';
+export declare function getLyricsApi(api: Api): LyricsApi;

package/lib/utils/api/{dlna-api.js → lyrics-api.js}

@@ -1,12 +1,12 @@
-import { DlnaApi } from '../../generated-client/api/dlna-api.js';
+import { LyricsApi } from '../../generated-client/api/lyrics-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 getDlnaApi(api) {
-    return new DlnaApi(api.configuration, undefined, api.axiosInstance);
+function getLyricsApi(api) {
+    return new LyricsApi(api.configuration, undefined, api.axiosInstance);
 }
 
-export { getDlnaApi };
+export { getLyricsApi };

package/lib/utils/api/{dlna-server-api.d.ts → trickplay-api.d.ts}

@@ -4,5 +4,5 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 import type { Api } from '../../api';
-import { DlnaServerApi } from '../../generated-client/api/dlna-server-api';
-export declare function getDlnaServerApi(api: Api): DlnaServerApi;
+import { TrickplayApi } from '../../generated-client/api/trickplay-api';
+export declare function getTrickplayApi(api: Api): TrickplayApi;

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

@@ -0,0 +1,12 @@
+import { TrickplayApi } from '../../generated-client/api/trickplay-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 getTrickplayApi(api) {
+    return new TrickplayApi(api.configuration, undefined, api.axiosInstance);
+}
+
+export { getTrickplayApi };

package/lib/utils/authentication.js

@@ -2,13 +2,12 @@
  * Returns a valid authorization header string.
  */
 function getAuthorizationHeader(clientInfo, deviceInfo, accessToken = '') {
-    // TODO: We should ensure values are properly escaped
     return [
-        `MediaBrowser Client="${clientInfo.name}"`,
-        `Device="${deviceInfo.name}"`,
-        `DeviceId="${deviceInfo.id}"`,
-        `Version="${clientInfo.version}"`,
-        `Token="${accessToken}"`
+        `MediaBrowser Client="${encodeURIComponent(clientInfo.name)}"`,
+        `Device="${encodeURIComponent(deviceInfo.name)}"`,
+        `DeviceId="${encodeURIComponent(deviceInfo.id)}"`,
+        `Version="${encodeURIComponent(clientInfo.version)}"`,
+        `Token="${encodeURIComponent(accessToken)}"`
     ].join(', ');
 }
 

package/lib/utils/index.d.ts

@@ -5,5 +5,6 @@
  */
 export * from './address-candidates';
 export * from './authentication';
-export * from './url';
 export * from './browser-profiles';
+export * from './url';
+export * from './versioning';

package/lib/utils/index.js

@@ -1,7 +1,8 @@
 export { JF_HTTPS_PORT, JF_HTTP_PORT, getAddressCandidates } from './address-candidates.js';
 export { getAuthorizationHeader } from './authentication.js';
-export { copyUrl, getDefaultPort, parseUrl } from './url/index.js';
 export { getBrowserDeviceProfile } from './browser-profiles.js';
+export { copyUrl, getDefaultPort, 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/versioning.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Check if given version is less than a baseline
+ *
+ * Versions must be in semver format: X.Y.Z (Major.Minor.Patch)
+ * @throws If version is not in a numeric-only semver format
+ * @param check - The version to check
+ * @param baseline - The minimum version considered supported
+ */
+export declare function isVersionLess(check: string, baseline: string): boolean;

package/lib/utils/versioning.js

@@ -0,0 +1,32 @@
+/**
+ * @returns - Array of 3 numbers or undefined
+ * (if the passed string it's not in the MAJOR.MINOR.PATCH numeric-only format)
+ */
+function parseVersion(version) {
+    const arr = version.split('.').map(Number);
+    if (arr.length === 3 && arr.every((n) => n >= 0)) {
+        return arr;
+    }
+}
+/**
+ * Check if given version is less than a baseline
+ *
+ * Versions must be in semver format: X.Y.Z (Major.Minor.Patch)
+ * @throws If version is not in a numeric-only semver format
+ * @param check - The version to check
+ * @param baseline - The minimum version considered supported
+ */
+function isVersionLess(check, baseline) {
+    const parsedCheck = parseVersion(check);
+    const parsedBaseline = parseVersion(baseline);
+    if (!parsedCheck || !parsedBaseline) {
+        throw new TypeError("Version doesn't match a numeric-only semver format");
+    }
+    const [majorCheck, minorCheck, patchCheck] = parsedCheck;
+    const [majorBaseline, minorBaseline, patchBaseline] = parsedBaseline;
+    return (majorCheck < majorBaseline ||
+        (majorCheck === majorBaseline && minorCheck < minorBaseline) ||
+        (majorCheck === majorBaseline && minorCheck === minorBaseline && patchCheck < patchBaseline));
+}
+
+export { isVersionLess };

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.8.9";
+export declare const API_VERSION = "10.9.4";
 /** The minimum supported server version. */
-export declare const MINIMUM_VERSION = "10.8.1";
+export declare const MINIMUM_VERSION = "10.9.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.8.9';
+const API_VERSION = '10.9.4';
 /** The minimum supported server version. */
-const MINIMUM_VERSION = '10.8.1';
+const MINIMUM_VERSION = '10.9.0';
 
 export { API_VERSION, MINIMUM_VERSION };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jellyfin/sdk",
-  "version": "0.8.2",
+  "version": "0.10.0",
   "description": "A TypeScript SDK for Jellyfin.",
   "keywords": [
     "jellyfin"
@@ -22,29 +22,24 @@
     "fix-schema": "node scripts/modify-schema.mjs openapi.json",
     "lint": "eslint \".\"",
     "prepublishOnly": "npm run clean:build:sdk",
-    "test": "jest --watchAll --group=unit"
+    "test": "vitest --exclude **/integration.test.ts"
   },
   "devDependencies": {
-    "@openapitools/openapi-generator-cli": "2.5.2",
-    "@rollup/plugin-typescript": "11.1.0",
-    "@tsconfig/recommended": "1.0.2",
-    "@types/jest": "29.5.0",
-    "@typescript-eslint/eslint-plugin": "5.57.1",
-    "@typescript-eslint/parser": "5.57.1",
-    "eslint": "8.37.0",
-    "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-jest": "27.2.1",
-    "glob": "9.3.4",
-    "jest": "29.5.0",
-    "jest-runner-groups": "2.2.0",
-    "rimraf": "4.4.1",
-    "rollup": "3.20.2",
-    "ts-jest": "29.1.0",
-    "typedoc": "0.23.28",
-    "typescript": "5.0.3"
-  },
-  "dependencies": {
-    "compare-versions": "5.0.3"
+    "@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"
   },
   "peerDependencies": {
     "axios": "^1.3.4"