@jellyfin/sdk 0.8.2 → 0.10.0

package/README.md

@@ -10,8 +10,8 @@
 <a href="https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/LICENSE"><img alt="MPL-2.0 license" src="https://img.shields.io/github/license/jellyfin/jellyfin-sdk-typescript"></a>
 <a href="https://github.com/jellyfin/jellyfin-sdk-typescript/releases"><img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-sdk-typescript.svg"/></a>
 <a href="https://www.npmjs.com/package/@jellyfin/sdk"><img alt="npm" src="https://img.shields.io/npm/v/@jellyfin/sdk"></a>
-<a href="https://codecov.io/gh/jellyfin/jellyfin-sdk-typescript">
-<img alt="Codecov" src="https://img.shields.io/codecov/c/github/jellyfin/jellyfin-sdk-typescript?token=eFF0jvWiyq">
+<a href="https://sonarcloud.io/component_measures?metric=coverage&id=jellyfin_jellyfin-sdk-typescript">
+<img alt="Sonar Coverage" src="https://img.shields.io/sonar/coverage/jellyfin_jellyfin-sdk-typescript/master?server=https%3A%2F%2Fsonarcloud.io">
 </a>
 </p>
 
@@ -35,7 +35,9 @@ yarn add @jellyfin/sdk
 
 | SDK Version | Jellyfin Version |
 |:-:|:-:|
-| 0.8.2 - 0.6.0 | 10.8.1 - 10.8.9 |
+| 0.10.0 | 10.9.x |
+| 0.9.0 | 10.9.x |
+| 0.8.2 - 0.6.0 | 10.8.1 - 10.8.13 |
 | 0.5.0 | 10.8.0 |
 | <0.5.0 | 10.7.x |
 
@@ -106,6 +108,14 @@ await api.logout();
 
 ## Breaking Changes
 
+### v0.10.0
+
+* Updated build target to ES2018. [#712](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/712)
+
+### v0.9.0
+
+* Updated OpenAPI spec for Jellyfin 10.9.1. [#694](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/694)
+
 ### v0.8.0
 
 * The library is now fully targeted to ES6/ES2015.
@@ -145,7 +155,7 @@ await api.logout();
 * [x] Use custom generator templates for API versions [#231](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/231) (Currently uses sed to update the value could be improved.)
 * [x] Automate OpenAPI spec updates using GitHub [#351](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/351)
 * [x] Create branch tracking unstable Jellyfin builds with automated builds [#354](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/354)
-* [ ] Fix authentication header escaping
+* [x] Fix authentication header escaping [#564](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/564)
 * [ ] Add WebSocket API support
 * [ ] Add example projects for different ecosystems [#186](https://github.com/jellyfin/jellyfin-sdk-typescript/issues/186)
 * [ ] Add utility function for `getFile` [#164](https://github.com/jellyfin/jellyfin-sdk-typescript/issues/164)

package/lib/api.d.ts

@@ -32,6 +32,7 @@ export declare class Api {
     logout(): Promise<AxiosResponse<never> | AxiosResponse<void>>;
     /**
      * Get an item image URL.
+     * @deprecated Use {@link ImageUrlsApi.getItemImageUrlById} instead.
      * @param itemId The Item ID.
      * @param imageType An optional Image Type (Primary by default).
      * @param params Additional request parameters.

package/lib/api.js

@@ -2,6 +2,7 @@ import globalAxios from 'axios';
 import { Configuration } from './generated-client/configuration.js';
 import { ImageType } from './generated-client/models/image-type.js';
 import { getAuthorizationHeader } from './utils/authentication.js';
+import { getImageApi } from './utils/api/image-api.js';
 import { getSessionApi } from './utils/api/session-api.js';
 import { getUserApi } from './utils/api/user-api.js';
 
@@ -50,16 +51,15 @@ class Api {
     }
     /**
      * Get an item image URL.
+     * @deprecated Use {@link ImageUrlsApi.getItemImageUrlById} instead.
      * @param itemId The Item ID.
      * @param imageType An optional Image Type (Primary by default).
      * @param params Additional request parameters.
      * @returns The image URL.
      */
     getItemImageUrl(itemId, imageType = ImageType.Primary, params = {}) {
-        // TODO: We could probably use ImageApiAxiosParamCreator to make this more robust
-        return globalAxios.create({
-            baseURL: this.basePath
-        }).getUri({ url: `/Items/${itemId}/Images/${imageType}`, params });
+        return getImageApi(this)
+            .getItemImageUrlById(itemId, imageType, params);
     }
     get authorizationHeader() {
         return getAuthorizationHeader(this.clientInfo, this.deviceInfo, this.accessToken);

package/lib/discovery/discovery-service.js

@@ -1,4 +1,3 @@
-import { __awaiter } from '../node_modules/tslib/tslib.es6.js';
 import { RecommendedServerInfoScore } from '../models/recommended-server-info.js';
 import { getAddressCandidates } from '../utils/address-candidates.js';
 import { RecommendedServerDiscovery } from './recommended-server-discovery.js';
@@ -49,10 +48,8 @@ class DiscoveryService {
      * @param minimumScore The minimum server score to include in the results.
      * @returns A list of RecommendedServerInfo from the possible server addresses.
      */
-    getRecommendedServers(servers, minimumScore) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.recommendedServerDiscovery.discover(servers, minimumScore);
-        });
+    async getRecommendedServers(servers, minimumScore) {
+        return this.recommendedServerDiscovery.discover(servers, minimumScore);
     }
     /**
      * Gets a list of recommended server information from the address
@@ -61,10 +58,8 @@ class DiscoveryService {
      * @param minimumScore The minimum server score to include in the results.
      * @returns A list of RecommendedServerInfo from the address candidates.
      */
-    getRecommendedServerCandidates(input, minimumScore) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.getRecommendedServers(this.getAddressCandidates(input), minimumScore);
-        });
+    async getRecommendedServerCandidates(input, minimumScore) {
+        return this.getRecommendedServers(this.getAddressCandidates(input), minimumScore);
     }
 }
 

package/lib/discovery/recommended-server-discovery.js

@@ -1,8 +1,7 @@
-import { __awaiter } from '../node_modules/tslib/tslib.es6.js';
-import { compare } from 'compare-versions';
 import { RecommendedServerInfoScore } from '../models/recommended-server-info.js';
 import { SystemInfoIssue, ProductNameIssue, VersionMissingIssue, VersionUnsupportedIssue, VersionOutdatedIssue, SlowResponseIssue } from '../models/recommended-server-issue.js';
 import { getSystemApi } from '../utils/api/system-api.js';
+import { isVersionLess } from '../utils/versioning.js';
 import { MINIMUM_VERSION, API_VERSION } from '../versions.js';
 
 /**
@@ -36,20 +35,28 @@ function toRecommendedServerInfo(result) {
         scores.push(RecommendedServerInfoScore.BAD);
     }
     const version = (_b = result.response) === null || _b === void 0 ? void 0 : _b.data.Version;
-    if (!version) {
-        // No version was returned
-        issues.push(new VersionMissingIssue());
-        scores.push(RecommendedServerInfoScore.BAD);
-    }
-    else if (compare(version, MINIMUM_VERSION, '<')) {
-        // Version is less than the minimum supported
-        issues.push(new VersionUnsupportedIssue(version));
-        scores.push(RecommendedServerInfoScore.OK);
+    try {
+        if (!version) {
+            // No version was returned
+            issues.push(new VersionMissingIssue());
+            scores.push(RecommendedServerInfoScore.BAD);
+        }
+        else if (isVersionLess(version, MINIMUM_VERSION)) {
+            // Version is less than the minimum supported
+            issues.push(new VersionUnsupportedIssue(version));
+            scores.push(RecommendedServerInfoScore.OK);
+        }
+        else if (isVersionLess(version, API_VERSION)) {
+            // Version is less than the generated client, but above the minimum
+            issues.push(new VersionOutdatedIssue(version));
+            scores.push(RecommendedServerInfoScore.GOOD);
+        }
     }
-    else if (compare(version, API_VERSION, '<')) {
-        // Version is less than the generated client, but above the minimum
-        issues.push(new VersionOutdatedIssue(version));
-        scores.push(RecommendedServerInfoScore.GOOD);
+    catch (error) {
+        if (error instanceof TypeError) {
+            issues.push(new VersionMissingIssue());
+            scores.push(RecommendedServerInfoScore.BAD);
+        }
     }
     if (result.responseTime > SLOW_RESPONSE_TIME) {
         // Response was slow
@@ -74,33 +81,29 @@ class RecommendedServerDiscovery {
      * @param address The server address.
      * @returns The resulting RecommendedServerInfo.
      */
-    fetchRecommendedServerInfo(address) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const api = this.jellyfin.createApi(address);
-            const startTime = Date.now();
-            return getSystemApi(api).getPublicSystemInfo({ timeout: HTTP_TIMEOUT })
-                .then(response => ({
-                address,
-                response,
-                responseTime: Date.now() - startTime
-            }))
-                .catch(error => ({
-                address,
-                error,
-                responseTime: Date.now() - startTime
-            }))
-                .then(result => toRecommendedServerInfo(result));
-        });
+    async fetchRecommendedServerInfo(address) {
+        const api = this.jellyfin.createApi(address);
+        const startTime = Date.now();
+        return getSystemApi(api).getPublicSystemInfo({ timeout: HTTP_TIMEOUT })
+            .then(response => ({
+            address,
+            response,
+            responseTime: Date.now() - startTime
+        }))
+            .catch(error => ({
+            address,
+            error,
+            responseTime: Date.now() - startTime
+        }))
+            .then(result => toRecommendedServerInfo(result));
     }
     /**
      * Fetches the RecommendedServerInfo for multiple server addresses.
      * @param servers An array of server addresses.
      * @returns The RecommendedServerInfo for each address.
      */
-    discover(servers, minimumScore = RecommendedServerInfoScore.BAD) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield Promise.all(servers.map(server => this.fetchRecommendedServerInfo(server)))).filter(serverInfo => serverInfo.score >= minimumScore);
-        });
+    async discover(servers, minimumScore = RecommendedServerInfoScore.BAD) {
+        return (await Promise.all(servers.map(server => this.fetchRecommendedServerInfo(server)))).filter(serverInfo => serverInfo.score >= minimumScore);
     }
 }
 

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

@@ -1,9 +1,19 @@
-import { __awaiter } from '../../node_modules/tslib/tslib.es6.js';
 import globalAxios from 'axios';
 import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common.js';
 import { BaseAPI, BASE_PATH } from '../base.js';
 
 /* 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/.
+ */
 /**
  * ActivityLogApi - axios parameter creator
  * @export
@@ -20,7 +30,7 @@ const ActivityLogApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLogEntries: (startIndex, limit, minDate, hasUserId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getLogEntries: async (startIndex, limit, minDate, hasUserId, 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);
@@ -28,11 +38,11 @@ const ActivityLogApiAxiosParamCreator = function (configuration) {
             if (configuration) {
                 baseOptions = configuration.baseOptions;
             }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
             // authentication CustomAuthentication required
-            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
             if (startIndex !== undefined) {
                 localVarQueryParameter['startIndex'] = startIndex;
             }
@@ -49,12 +59,12 @@ const ActivityLogApiAxiosParamCreator = function (configuration) {
             }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
             };
-        }),
+        },
     };
 };
 /**
@@ -74,11 +84,9 @@ const ActivityLogApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLogEntries(startIndex, limit, minDate, hasUserId, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLogEntries(startIndex, limit, minDate, hasUserId, options);
-                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-            });
+        async getLogEntries(startIndex, limit, minDate, hasUserId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLogEntries(startIndex, limit, minDate, hasUserId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     };
 };

package/lib/generated-client/api/api-key-api.js

@@ -1,9 +1,19 @@
-import { __awaiter } from '../../node_modules/tslib/tslib.es6.js';
 import globalAxios from 'axios';
 import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common.js';
 import { BaseAPI, BASE_PATH } from '../base.js';
 
 /* 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/.
+ */
 /**
  * ApiKeyApi - axios parameter creator
  * @export
@@ -17,7 +27,7 @@ const ApiKeyApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createKey: (app, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        createKey: async (app, options = {}) => {
             // verify required parameter 'app' is not null or undefined
             assertParamExists('createKey', 'app', app);
             const localVarPath = `/Auth/Keys`;
@@ -27,29 +37,29 @@ const ApiKeyApiAxiosParamCreator = function (configuration) {
             if (configuration) {
                 baseOptions = configuration.baseOptions;
             }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
             // authentication CustomAuthentication required
-            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
             if (app !== undefined) {
                 localVarQueryParameter['app'] = app;
             }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
             };
-        }),
+        },
         /**
          *
          * @summary Get all keys.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getKeys: (options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getKeys: async (options = {}) => {
             const localVarPath = `/Auth/Keys`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -57,19 +67,19 @@ const ApiKeyApiAxiosParamCreator = function (configuration) {
             if (configuration) {
                 baseOptions = configuration.baseOptions;
             }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
             // authentication CustomAuthentication required
-            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
             };
-        }),
+        },
         /**
          *
          * @summary Remove an api key.
@@ -77,7 +87,7 @@ const ApiKeyApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        revokeKey: (key, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        revokeKey: async (key, options = {}) => {
             // verify required parameter 'key' is not null or undefined
             assertParamExists('revokeKey', 'key', key);
             const localVarPath = `/Auth/Keys/{key}`
@@ -88,19 +98,19 @@ const ApiKeyApiAxiosParamCreator = function (configuration) {
             if (configuration) {
                 baseOptions = configuration.baseOptions;
             }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
             // authentication CustomAuthentication required
-            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
             };
-        }),
+        },
     };
 };
 /**
@@ -117,11 +127,9 @@ const ApiKeyApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createKey(app, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.createKey(app, options);
-                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-            });
+        async createKey(app, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createKey(app, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
          *
@@ -129,11 +137,9 @@ const ApiKeyApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getKeys(options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getKeys(options);
-                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-            });
+        async getKeys(options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getKeys(options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
          *
@@ -142,11 +148,9 @@ const ApiKeyApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        revokeKey(key, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.revokeKey(key, options);
-                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-            });
+        async revokeKey(key, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.revokeKey(key, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     };
 };