@ctrl/plex 3.10.0 → 3.12.0

package/dist/src/alert.js

@@ -1,9 +1,11 @@
 import WebSocket from 'ws';
 export class AlertListener {
+    server;
+    callback;
+    key = '/:/websockets/notifications';
     constructor(server, callback) {
         this.server = server;
         this.callback = callback;
-        this.key = '/:/websockets/notifications';
     }
     async run() {
         const url = this.server.url(this.key, true).toString().replace('http', 'ws');

package/dist/src/audio.js

@@ -1,13 +1,14 @@
-import { URLSearchParams } from 'url';
+import { URLSearchParams } from 'node:url';
 import { Playable } from './base/playable.js';
 import { fetchItem, fetchItems } from './baseFunctionality.js';
 import { Chapter, Collection, Country, Field, Format, Genre, Guid, Image, Label, Media, Mood, Similar, Style, Subformat, } from './media.js';
+const hasSonicAdventure = (s) => typeof s.sonicAdventure === 'function';
 /**
  * Base class for all audio objects including Artist, Album, and Track.
  */
 export class Audio extends Playable {
     /** Default metadata type for audio sync items. */
-    static { this.METADATA_TYPE = 'track'; }
+    static METADATA_TYPE = 'track';
     /** Hardcoded list type for filtering. */
     get listType() {
         return 'audio';
@@ -83,53 +84,61 @@ export class Audio extends Playable {
      */
     _loadData(data) {
         this._data = data;
-        const addedAtTimestamp = data.addedAt ? parseInt(data.addedAt, 10) : NaN;
-        this.addedAt = isNaN(addedAtTimestamp) ? undefined : new Date(addedAtTimestamp * 1000);
+        const addedAtTimestamp = data.addedAt ? Number.parseInt(data.addedAt, 10) : Number.NaN;
+        this.addedAt = Number.isNaN(addedAtTimestamp) ? undefined : new Date(addedAtTimestamp * 1000);
         this.art = data.art ? this.server.url(data.art, true)?.toString() : undefined;
         this.artBlurHash = data.artBlurHash;
-        const distanceFloat = data.distance ? parseFloat(data.distance) : NaN;
-        this.distance = isNaN(distanceFloat) ? undefined : distanceFloat;
+        const distanceFloat = data.distance ? Number.parseFloat(data.distance) : Number.NaN;
+        this.distance = Number.isNaN(distanceFloat) ? undefined : distanceFloat;
         this.guid = data.guid;
-        const indexInt = data.index ? parseInt(data.index, 10) : NaN;
-        this.index = isNaN(indexInt) ? undefined : indexInt;
+        const indexInt = data.index ? Number.parseInt(data.index, 10) : Number.NaN;
+        this.index = Number.isNaN(indexInt) ? undefined : indexInt;
         this.key = data.key ?? this.key ?? '';
-        const lastRatedAtTimestamp = data.lastRatedAt ? parseInt(data.lastRatedAt, 10) : NaN;
-        this.lastRatedAt = isNaN(lastRatedAtTimestamp)
+        const lastRatedAtTimestamp = data.lastRatedAt
+            ? Number.parseInt(data.lastRatedAt, 10)
+            : Number.NaN;
+        this.lastRatedAt = Number.isNaN(lastRatedAtTimestamp)
             ? undefined
             : new Date(lastRatedAtTimestamp * 1000);
-        const lastViewedAtTimestamp = data.lastViewedAt ? parseInt(data.lastViewedAt, 10) : NaN;
-        this.lastViewedAt = isNaN(lastViewedAtTimestamp)
+        const lastViewedAtTimestamp = data.lastViewedAt
+            ? Number.parseInt(data.lastViewedAt, 10)
+            : Number.NaN;
+        this.lastViewedAt = Number.isNaN(lastViewedAtTimestamp)
             ? undefined
             : new Date(lastViewedAtTimestamp * 1000);
-        const librarySectionIDInt = data.librarySectionID ? parseInt(data.librarySectionID, 10) : NaN;
-        this.librarySectionID = isNaN(librarySectionIDInt)
+        const librarySectionIDInt = data.librarySectionID
+            ? Number.parseInt(data.librarySectionID, 10)
+            : Number.NaN;
+        this.librarySectionID = Number.isNaN(librarySectionIDInt)
             ? this.librarySectionID
             : librarySectionIDInt;
         this.librarySectionKey = data.librarySectionKey;
         this.librarySectionTitle = data.librarySectionTitle;
         // listType is handled by the getter
         const musicAnalysisVersionInt = data.musicAnalysisVersion
-            ? parseInt(data.musicAnalysisVersion, 10)
-            : NaN;
-        this.musicAnalysisVersion = isNaN(musicAnalysisVersionInt)
+            ? Number.parseInt(data.musicAnalysisVersion, 10)
+            : Number.NaN;
+        this.musicAnalysisVersion = Number.isNaN(musicAnalysisVersionInt)
             ? undefined
             : musicAnalysisVersionInt;
         this.playlistItemID = data.playlistItemID;
         this.ratingKey = data.ratingKey;
-        const ratingKeyInt = data.ratingKey ? parseInt(data.ratingKey, 10) : NaN;
-        this.ratingKey = isNaN(ratingKeyInt) ? this.ratingKey : ratingKeyInt.toString();
+        const ratingKeyInt = data.ratingKey ? Number.parseInt(data.ratingKey, 10) : Number.NaN;
+        this.ratingKey = Number.isNaN(ratingKeyInt) ? this.ratingKey : ratingKeyInt.toString();
         this.summary = data.summary;
         this.thumb = data.thumb ? this.server.url(data.thumb, true)?.toString() : undefined;
         this.thumbBlurHash = data.thumbBlurHash;
         this.title = data.title ?? this.title;
         this.titleSort = data.titleSort ?? this.title;
         this.type = data.type ?? this.type;
-        const updatedAtTimestamp = data.updatedAt ? parseInt(data.updatedAt, 10) : NaN;
-        this.updatedAt = isNaN(updatedAtTimestamp) ? undefined : new Date(updatedAtTimestamp * 1000);
-        const userRatingFloat = data.userRating ? parseFloat(data.userRating) : NaN;
-        this.userRating = isNaN(userRatingFloat) ? undefined : userRatingFloat;
-        const viewCountInt = data.viewCount !== undefined ? parseInt(data.viewCount, 10) : NaN;
-        this.viewCount = isNaN(viewCountInt) ? 0 : viewCountInt;
+        const updatedAtTimestamp = data.updatedAt ? Number.parseInt(data.updatedAt, 10) : Number.NaN;
+        this.updatedAt = Number.isNaN(updatedAtTimestamp)
+            ? undefined
+            : new Date(updatedAtTimestamp * 1000);
+        const userRatingFloat = data.userRating ? Number.parseFloat(data.userRating) : Number.NaN;
+        this.userRating = Number.isNaN(userRatingFloat) ? undefined : userRatingFloat;
+        const viewCountInt = data.viewCount !== undefined ? Number.parseInt(data.viewCount, 10) : Number.NaN;
+        this.viewCount = Number.isNaN(viewCountInt) ? 0 : viewCountInt;
         // Map tag arrays like video.ts does
         this.fields = data.Field?.map((d) => new Field(this.server, d, undefined, this)) ?? [];
         this.images = data.Image?.map((d) => new Image(this.server, d, undefined, this)) ?? [];
@@ -153,8 +162,8 @@ export class Audio extends Playable {
  * Represents a single Track.
  */
 export class Track extends Audio {
-    static { this.TAG = 'Track'; }
-    static { this.TYPE = 'track'; }
+    static TAG = 'Track';
+    static TYPE = 'track';
     // Properties from Mixins (assuming, some might overlap with Audio)
     // userRating inherited from Audio
     // art inherited from Audio
@@ -238,7 +247,6 @@ export class Track extends Audio {
      */
     async sonicAdventure(to) {
         const section = await this.section();
-        const hasSonicAdventure = (s) => typeof s.sonicAdventure === 'function';
         if (!hasSonicAdventure(section)) {
             throw new Error('Section does not support sonicAdventure');
         }
@@ -309,8 +317,8 @@ export class Track extends Audio {
  */
 export class Artist extends Audio {
     /* implements AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, ExtrasMixin, HubsMixin, RatingMixin, ArtMixin, PosterMixin, ThemeMixin, ArtistEditMixins */
-    static { this.TAG = 'Directory'; }
-    static { this.TYPE = 'artist'; }
+    static TAG = 'Directory';
+    static TYPE = 'artist';
     get locations() {
         // Replicate listAttrs logic (assuming Location tag with path attribute)
         return this._data?.Location?.map((loc) => loc.path).filter(Boolean) ?? [];
@@ -459,13 +467,15 @@ export class Artist extends Audio {
      */
     _loadData(data) {
         super._loadData(data);
-        const albumSortInt = data.albumSort ? parseInt(String(data.albumSort), 10) : NaN;
-        this.albumSort = isNaN(albumSortInt) ? -1 : albumSortInt;
-        const audienceRatingFloat = data.audienceRating !== undefined ? parseFloat(String(data.audienceRating)) : NaN;
-        this.audienceRating = isNaN(audienceRatingFloat) ? undefined : audienceRatingFloat;
+        const albumSortInt = data.albumSort ? Number.parseInt(String(data.albumSort), 10) : Number.NaN;
+        this.albumSort = Number.isNaN(albumSortInt) ? -1 : albumSortInt;
+        const audienceRatingFloat = data.audienceRating !== undefined
+            ? Number.parseFloat(String(data.audienceRating))
+            : Number.NaN;
+        this.audienceRating = Number.isNaN(audienceRatingFloat) ? undefined : audienceRatingFloat;
         this.key = data.key?.replace('/children', '');
-        const ratingFloat = data.rating !== undefined ? parseFloat(String(data.rating)) : NaN;
-        this.rating = isNaN(ratingFloat) ? undefined : ratingFloat;
+        const ratingFloat = data.rating !== undefined ? Number.parseFloat(String(data.rating)) : Number.NaN;
+        this.rating = Number.isNaN(ratingFloat) ? undefined : ratingFloat;
         this.theme = data.theme;
         this.countries = data.Country?.map(d => new Country(this.server, d, undefined, this));
         this.genres = data.Genre?.map(d => new Genre(this.server, d, undefined, this));
@@ -480,8 +490,8 @@ export class Artist extends Audio {
  * Represents a single Album.
  */
 export class Album extends Audio {
-    static { this.TAG = 'Directory'; }
-    static { this.TYPE = 'album'; }
+    static TAG = 'Directory';
+    static TYPE = 'album';
     constructor(server, data, initpath, parent) {
         super(server, data, initpath, parent);
         this._loadData(data);
@@ -551,7 +561,7 @@ export class Album extends Audio {
                 ? new Date(data.originallyAvailableAt)
                 : undefined;
             // Check if the date is valid
-            if (this.originallyAvailableAt && isNaN(this.originallyAvailableAt.getTime())) {
+            if (this.originallyAvailableAt && Number.isNaN(this.originallyAvailableAt.getTime())) {
                 this.originallyAvailableAt = undefined;
             }
         }

package/dist/src/audio.types.d.ts

@@ -66,12 +66,12 @@ export interface TrackData {
     skipCount?: number;
     source?: string;
     viewOffset?: number;
-    Chapter?: import('./video.types.js').ChapterData[];
+    Chapter?: Array<import('./video.types.js').ChapterData>;
     Collection?: MediaTagData[];
     Genre?: MediaTagData[];
     Guid?: MediaTagData[];
     Label?: MediaTagData[];
-    Media?: import('./video.types.js').MediaData[];
+    Media?: Array<import('./video.types.js').MediaData>;
 }
 export interface ArtistData {
     key: string;

package/dist/src/base/partialPlexObject.js

@@ -1,33 +1,30 @@
-import { URLSearchParams } from 'url';
+import { URLSearchParams } from 'node:url';
 import { SearchResult, searchType } from '../search.js';
 import { getAgentIdentifier, ltrim, tagHelper } from '../util.js';
 import { PlexObject } from './plexObject.js';
 export class PartialPlexObject extends PlexObject {
-    constructor() {
-        super(...arguments);
-        this._INCLUDES = {
-            checkFiles: 0,
-            includeAllConcerts: 0,
-            includeBandwidths: 1,
-            includeChapters: 1,
-            includeChildren: 0,
-            includeConcerts: 0,
-            includeExternalMedia: 0,
-            includeExtras: 0,
-            includeFields: 'thumbBlurHash,artBlurHash',
-            includeGeolocation: 1,
-            includeLoudnessRamps: 1,
-            includeMarkers: 1,
-            includeOnDeck: 0,
-            includePopularLeaves: 0,
-            includePreferences: 0,
-            includeRelated: 0,
-            includeRelatedCount: 0,
-            includeReviews: 0,
-            includeStations: 0,
-        };
-        this._detailsKey = this._buildDetailsKey();
-    }
+    _INCLUDES = {
+        checkFiles: 0,
+        includeAllConcerts: 0,
+        includeBandwidths: 1,
+        includeChapters: 1,
+        includeChildren: 0,
+        includeConcerts: 0,
+        includeExternalMedia: 0,
+        includeExtras: 0,
+        includeFields: 'thumbBlurHash,artBlurHash',
+        includeGeolocation: 1,
+        includeLoudnessRamps: 1,
+        includeMarkers: 1,
+        includeOnDeck: 0,
+        includePopularLeaves: 0,
+        includePreferences: 0,
+        includeRelated: 0,
+        includeRelatedCount: 0,
+        includeReviews: 0,
+        includeStations: 0,
+    };
+    _detailsKey = this._buildDetailsKey();
     /**
      * Tell Plex Media Server to performs analysis on it this item to gather
      *  information. Analysis includes:
@@ -83,7 +80,7 @@ export class PartialPlexObject extends PlexObject {
         const key = `/library/metadata/${this.ratingKey}/match`;
         if (auto) {
             const autoMatch = await this.matches();
-            if (autoMatch.length) {
+            if (autoMatch.length > 0) {
                 searchResult = autoMatch[0];
             }
             else {
@@ -173,7 +170,7 @@ export class PartialPlexObject extends PlexObject {
      * @param maxresults Only return the specified number of results (optional).
      * @param mindate Min datetime to return results from.
      */
-    async history(maxresults = 9999999, mindate) {
+    async history(maxresults = 9_999_999, mindate) {
         return this.server.history(maxresults, mindate, this.ratingKey);
     }
     async section() {
@@ -260,7 +257,7 @@ export class PartialPlexObject extends PlexObject {
      * @param remove If this is active remove the tags in items.
      */
     async _editTags(tag, items, locked = true, remove = false) {
-        const value = this[tag + 's'];
+        const value = this[`${tag}s`];
         const existingCols = value?.filter((x) => x && remove).map((x) => x.tag) ?? [];
         const d = tagHelper(tag, [...existingCols, ...items], locked, remove);
         await this.edit(d);

package/dist/src/base/playable.d.ts

@@ -1,4 +1,4 @@
-import type { PlayQueue as PlayQueueType } from '../playqueue.js';
+import { type PlayQueue as PlayQueueType } from '../playqueue.js';
 import type { CreatePlayQueueOptions } from '../playqueue.types.js';
 import { PartialPlexObject } from './partialPlexObject.js';
 /**

package/dist/src/base/plexObject.js

@@ -1,12 +1,20 @@
-import { URLSearchParams } from 'url';
+import { URLSearchParams } from 'node:url';
 /**
  * Base class for all? Plex objects
  */
 export class PlexObject {
+    server;
     /** xml element tag */
-    static { this.TAG = null; }
+    static TAG = null;
     /** xml element type */
-    static { this.TYPE = null; }
+    static TYPE = null;
+    /**
+     * WeakRef to the parent object that this object is built from.
+     */
+    parent;
+    _detailsKey;
+    initpath;
+    _INCLUDES;
     constructor(server, data, initpath, parent) {
         this.server = server;
         this.initpath = initpath ?? this.key;
@@ -53,8 +61,8 @@ export class PlexObject {
                     params.set(k, (value === true ? 1 : value).toString());
                 }
             }
-            if ([...params.keys()].length) {
-                detailsKey += '?' + params.toString();
+            if ([...params.keys()].length > 0) {
+                detailsKey += `?${params.toString()}`;
             }
         }
         return detailsKey;

package/dist/src/client.d.ts

@@ -1,4 +1,4 @@
-import { URL } from 'url';
+import { URL } from 'node:url';
 import type { Player } from './client.types.js';
 export interface PlexOptions {
     /** (:class:`~plexapi.server.PlexServer`): PlexServer this client is connected to (optional). */
@@ -57,6 +57,7 @@ export declare class PlexClient {
     _token: string | null;
     TAG: string;
     key: string;
+    timeout: number;
     deviceClass?: string;
     machineIdentifier?: string;
     product?: string;
@@ -66,7 +67,6 @@ export declare class PlexClient {
     platform?: string;
     platformVersion?: string;
     title?: string;
-    timeout: number;
     constructor(options?: PlexOptions);
     /**
      * Alias of reload as any subsequent requests to this client will be

package/dist/src/client.js

@@ -1,5 +1,5 @@
+import { URL, URLSearchParams } from 'node:url';
 import { ofetch } from 'ofetch';
-import { URL, URLSearchParams } from 'url';
 import { BASE_HEADERS, TIMEOUT } from './config.js';
 /**
  * Main class for interacting with a Plex client. This class can connect
@@ -32,17 +32,18 @@ import { BASE_HEADERS, TIMEOUT } from './config.js';
  *         :func:`~plexapi.client.PlexClient.proxyThroughServer()` (default False).
  */
 export class PlexClient {
+    /**
+     * HTTP address of the client
+     */
+    _baseurl = null;
+    /**
+     * Token used to access this client
+     */
+    _token = null;
+    TAG = 'Player';
+    key = '/resources';
+    timeout;
     constructor(options = {}) {
-        /**
-         * HTTP address of the client
-         */
-        this._baseurl = null;
-        /**
-         * Token used to access this client
-         */
-        this._token = null;
-        this.TAG = 'Player';
-        this.key = '/resources';
         if (options.baseurl) {
             if (options.baseurl.endsWith('/')) {
                 this._baseurl = options.baseurl.slice(0, -1);

package/dist/src/config.js

@@ -1,4 +1,4 @@
-import os from 'os';
+import os from 'node:os';
 import { getMAC, parseMAC } from '@ctrl/mac-address';
 // TODO: Load User Defined Config
 // const DEFAULT_CONFIG_PATH = os.path.expanduser('~/.config/plexapi/config.ini');

package/dist/src/exceptions.js

@@ -1,39 +1,39 @@
 export class BadRequest extends Error {
+    message = 'An invalid request, generally a user error.';
     constructor(message) {
         super(message);
-        this.message = 'An invalid request, generally a user error.';
         this.name = 'BadRequest';
         this.message = message;
     }
 }
 export class NotFound extends Error {
+    message = 'Request media item or device is not found.';
     constructor(message) {
         super(message);
-        this.message = 'Request media item or device is not found.';
         this.name = 'NotFound';
         this.message = message;
     }
 }
 export class UnknownType extends Error {
+    message = 'Unknown library type.';
     constructor(message) {
         super(message);
-        this.message = 'Unknown library type.';
         this.name = 'UnknownType';
         this.message = message;
     }
 }
 export class Unsupported extends Error {
+    message = 'Unsupported client request.';
     constructor(message) {
         super(message);
-        this.message = 'Unsupported client request.';
         this.name = 'Unsupported';
         this.message = message;
     }
 }
 export class Unauthorized extends Error {
+    message = 'Invalid username or password.';
     constructor(message) {
         super(message);
-        this.message = 'Invalid username or password.';
         this.name = 'Unauthorized';
         this.message = message;
     }

package/dist/src/library.d.ts

@@ -365,7 +365,7 @@ export declare abstract class LibrarySection<SType = SectionType> extends PlexOb
      * Returns a list of playlists from this library section.
      */
     playlists(): Promise<Playlist[]>;
-    collections(args?: Record<string, number | string | boolean>): Promise<Collections<SType>[]>;
+    collections(args?: Record<string, number | string | boolean>): Promise<Array<Collections<SType>>>;
     /**
      * Returns a list of available Folders for this library section.
      */