@ctrl/plex 3.10.0 → 3.12.0

package/dist/src/library.js

@@ -1,4 +1,4 @@
-import { URLSearchParams } from 'url';
+import { URLSearchParams } from 'node:url';
 import { PartialPlexObject } from './base/partialPlexObject.js';
 import { PlexObject } from './base/plexObject.js';
 import { Album, Artist, Track } from './audio.js';
@@ -8,7 +8,8 @@ import { Playlist } from './playlist.js';
 import { searchType } from './search.js';
 import { Movie, Show } from './video.js';
 export class Library {
-    static { this.key = '/library'; }
+    server;
+    static key = '/library';
     constructor(server, data) {
         this.server = server;
         this._loadData(data);
@@ -35,9 +36,9 @@ export class Library {
     }
     async section(title) {
         const sections = await this.sections();
-        const section = sections.find(s => s.title.toLowerCase() === title.toLowerCase());
+        const section = sections.find(s => s.title?.toLowerCase() === title.toLowerCase());
         if (!section) {
-            const avilableSections = sections.map(s => s.title).join(', ');
+            const avilableSections = sections.map(s => s.title || 'Unknown').join(', ');
             throw new Error(`Invalid library section: ${title}. Available: ${avilableSections}`);
         }
         return section;
@@ -205,7 +206,7 @@ export class Library {
             language,
             ...extra,
         });
-        const url = '/library/sections?' + search.toString();
+        const url = `/library/sections?${search.toString()}`;
         return this.server.query(url, 'post');
     }
     /**
@@ -275,9 +276,10 @@ export class Library {
  * Base class for a single library section.
  */
 export class LibrarySection extends PlexObject {
-    static { this.ALLOWED_FILTERS = []; }
-    static { this.ALLOWED_SORT = []; }
-    static { this.BOOLEAN_FILTERS = ['unwatched', 'duplicate']; }
+    static ALLOWED_FILTERS = [];
+    static ALLOWED_SORT = [];
+    static BOOLEAN_FILTERS = ['unwatched', 'duplicate'];
+    SECTION_TYPE;
     async all(sort = '') {
         let sortStr = '';
         if (sort) {
@@ -573,14 +575,8 @@ export class LibrarySection extends PlexObject {
     }
 }
 export class MovieSection extends LibrarySection {
-    constructor() {
-        super(...arguments);
-        this.METADATA_TYPE = 'movie';
-        this.CONTENT_TYPE = 'video';
-        this.SECTION_TYPE = Movie;
-    }
-    static { this.TYPE = 'movie'; }
-    static { this.ALLOWED_FILTERS = [
+    static TYPE = 'movie';
+    static ALLOWED_FILTERS = [
         'unwatched',
         'duplicate',
         'year',
@@ -602,8 +598,8 @@ export class MovieSection extends LibrarySection {
         'lastViewedAt',
         'viewCount',
         'addedAt',
-    ]; }
-    static { this.ALLOWED_SORT = [
+    ];
+    static ALLOWED_SORT = [
         'addedAt',
         'originallyAvailableAt',
         'lastViewedAt',
@@ -611,18 +607,15 @@ export class MovieSection extends LibrarySection {
         'rating',
         'mediaHeight',
         'duration',
-    ]; }
-    static { this.TAG = 'Directory'; }
+    ];
+    static TAG = 'Directory';
+    METADATA_TYPE = 'movie';
+    CONTENT_TYPE = 'video';
+    SECTION_TYPE = Movie;
 }
 export class ShowSection extends LibrarySection {
-    constructor() {
-        super(...arguments);
-        this.METADATA_TYPE = 'episode';
-        this.CONTENT_TYPE = 'video';
-        this.SECTION_TYPE = Show;
-    }
-    static { this.TYPE = 'show'; }
-    static { this.ALLOWED_FILTERS = [
+    static TYPE = 'show';
+    static ALLOWED_FILTERS = [
         'unwatched',
         'year',
         'genre',
@@ -648,16 +641,19 @@ export class ShowSection extends LibrarySection {
         'episode.userRating',
         'episode.viewCount',
         'episode.lastViewedAt',
-    ]; }
-    static { this.ALLOWED_SORT = [
+    ];
+    static ALLOWED_SORT = [
         'addedAt',
         'lastViewedAt',
         'originallyAvailableAt',
         'titleSort',
         'rating',
         'unwatched',
-    ]; }
-    static { this.TAG = 'Directory'; }
+    ];
+    static TAG = 'Directory';
+    METADATA_TYPE = 'episode';
+    CONTENT_TYPE = 'video';
+    SECTION_TYPE = Show;
     // TODO: figure out how to return episode objects
     // /**
     //  * Search for an episode. See :func:`~plexapi.library.LibrarySection.search` for usage.
@@ -675,14 +671,11 @@ export class ShowSection extends LibrarySection {
     }
 }
 export class MusicSection extends LibrarySection {
-    constructor() {
-        super(...arguments);
-        this.METADATA_TYPE = 'track';
-        this.CONTENT_TYPE = 'audio';
-        this.SECTION_TYPE = Track;
-    }
-    static { this.TYPE = 'artist'; }
-    static { this.TAG = 'Directory'; }
+    static TYPE = 'artist';
+    static TAG = 'Directory';
+    METADATA_TYPE = 'track';
+    CONTENT_TYPE = 'audio';
+    SECTION_TYPE = Track;
     /** Returns a list of Album objects in this section. */
     async albums() {
         const key = `/library/sections/${this.key}/albums`;
@@ -736,7 +729,7 @@ export class MusicSection extends LibrarySection {
 }
 /** Represents a single Hub (or category) in the PlexServer search */
 export class Hub extends PlexObject {
-    static { this.TAG = 'Hub'; }
+    static TAG = 'Hub';
     _loadData(data) {
         this.hubIdentifier = data.hubIdentifier;
         this.size = data.size;
@@ -766,11 +759,8 @@ export class Folder extends PlexObject {
     }
 }
 export class Collections extends PartialPlexObject {
-    constructor() {
-        super(...arguments);
-        this.TYPE = 'collection';
-    }
-    static { this.TAG = 'Directory'; }
+    static TAG = 'Directory';
+    TYPE = 'collection';
     // Alias for childCount
     get size() {
         return this.childCount;
@@ -809,7 +799,7 @@ export class Collections extends PartialPlexObject {
     }
 }
 export class FilterChoice extends PlexObject {
-    static { this.TAG = 'Directory'; }
+    static TAG = 'Directory';
     _loadData(data) {
         this.key = data.key;
         this.title = data.title;
@@ -818,7 +808,7 @@ export class FilterChoice extends PlexObject {
     }
 }
 export class FilteringType extends PlexObject {
-    static { this.TAG = 'Type'; }
+    static TAG = 'Type';
     _loadData(data) {
         this.active = data.active;
         this.fields = findItems(data, undefined, FilteringField);
@@ -833,7 +823,7 @@ export class FilteringType extends PlexObject {
  * Represents a single Filter object for a {@link FilteringType}
  */
 export class FilteringFilter extends PlexObject {
-    static { this.TAG = 'Filter'; }
+    static TAG = 'Filter';
     _loadData(data) {
         this.filter = data.filter;
         this.filterType = data.filterType;
@@ -846,7 +836,7 @@ export class FilteringFilter extends PlexObject {
  * Represents a single Sort object for a {@link FilteringType}
  */
 export class FilteringSort extends PlexObject {
-    static { this.TAG = 'Sort'; }
+    static TAG = 'Sort';
     _loadData(data) {
         this.active = data.active;
         this.activeDirection = data.activeDirection;
@@ -862,7 +852,7 @@ export class FilteringSort extends PlexObject {
  * Represents a single Field object for a {@link FilteringType}
  */
 export class FilteringField extends PlexObject {
-    static { this.TAG = 'Field'; }
+    static TAG = 'Field';
     _loadData(data) {
         this.key = data.key;
         this.title = data.title;
@@ -874,7 +864,7 @@ export class FilteringField extends PlexObject {
  * Represents a single FieldType for library filtering.
  */
 export class FilteringFieldType extends PlexObject {
-    static { this.TAG = 'FieldType'; }
+    static TAG = 'FieldType';
     _loadData(data) {
         this.type = data.type;
         this.operators = findItems(data, undefined, FilteringOperator);
@@ -884,7 +874,7 @@ export class FilteringFieldType extends PlexObject {
  * Represents a single FilterChoice for library filtering.
  */
 export class FilteringOperator extends PlexObject {
-    static { this.TAG = 'Operator'; }
+    static TAG = 'Operator';
     _loadData(data) {
         this.key = data.key;
         this.type = data.type;

package/dist/src/media.js

@@ -5,6 +5,7 @@ import { PlexObject } from './base/plexObject.js';
  * the construct used for things such as Country, Director, Genre, etc.
  */
 class MediaTag extends PlexObject {
+    static TAG;
     // async items(): Promise<any[]> {
     //   if (!this.key) {
     //     throw new Error(`Key is not defined for this tag: ${this.tag}`);
@@ -19,7 +20,7 @@ class MediaTag extends PlexObject {
     }
 }
 export class Media extends PlexObject {
-    static { this.TAG = 'Media'; }
+    static TAG = 'Media';
     _loadData(data) {
         this.aspectRatio = data.aspectRatio;
         this.audioChannels = data.audioChannels;
@@ -39,7 +40,7 @@ export class Media extends PlexObject {
     }
 }
 export class MediaPart extends PlexObject {
-    static { this.TAG = 'Part'; }
+    static TAG = 'Part';
     /**
      * Set the selected {@link AudioStream} for this MediaPart.
      * @param stream Audio stream or stream ID to set as selected.
@@ -49,7 +50,7 @@ export class MediaPart extends PlexObject {
         const params = new URLSearchParams({ allParts: '1' });
         const streamId = typeof stream === 'number' ? stream : stream.id;
         params.set('audioStreamID', streamId.toString());
-        await this.server.query(key + '?' + params.toString(), 'put');
+        await this.server.query(`${key}?${params.toString()}`, 'put');
         return this;
     }
     /**
@@ -61,7 +62,7 @@ export class MediaPart extends PlexObject {
         const params = new URLSearchParams({ allParts: '1' });
         const streamId = typeof stream === 'number' ? stream : stream.id;
         params.set('subtitleStreamID', streamId.toString());
-        await this.server.query(key + '?' + params.toString(), 'put');
+        await this.server.query(`${key}?${params.toString()}`, 'put');
         return this;
     }
     /**
@@ -97,7 +98,7 @@ export class MediaPart extends PlexObject {
     }
 }
 export class MediaPartStream extends PlexObject {
-    static { this.TAG = 'Stream'; }
+    static TAG = 'Stream';
     _loadData(data) {
         this.id = data.id;
         this.codec = data.codec;
@@ -112,8 +113,8 @@ export class MediaPartStream extends PlexObject {
  * Represents a single Subtitle stream within a {@link MediaPart}.
  */
 export class SubtitleStream extends MediaPartStream {
-    static { this.TAG = 'Stream'; }
-    static { this.STREAMTYPE = 3; }
+    static TAG = 'Stream';
+    static STREAMTYPE = 3;
     /**
      * Sets this subtitle stream as the selected subtitle stream.
      * Alias for `MediaPart.setSelectedSubtitleStream`.
@@ -129,102 +130,78 @@ export class SubtitleStream extends MediaPartStream {
         super._loadData(data);
         this.canAutoSync = Boolean(data.canAutoSync); // Use !! for boolean casting from potential string/number
         this.container = data.container;
-        this.forced = Boolean(parseInt(data.forced ?? '0', 10));
+        this.forced = Boolean(Number.parseInt(data.forced ?? '0', 10));
         this.format = data.format;
         this.headerCompression = data.headerCompression;
-        this.hearingImpaired = Boolean(parseInt(data.hearingImpaired ?? '0', 10));
+        this.hearingImpaired = Boolean(Number.parseInt(data.hearingImpaired ?? '0', 10));
         this.perfectMatch = Boolean(data.perfectMatch);
         this.providerTitle = data.providerTitle;
-        this.score = data.score ? parseInt(data.score, 10) : undefined;
+        this.score = data.score ? Number.parseInt(data.score, 10) : undefined;
         this.sourceKey = data.sourceKey;
         this.transient = data.transient;
-        this.userID = data.userID ? parseInt(data.userID, 10) : undefined;
+        this.userID = data.userID ? Number.parseInt(data.userID, 10) : undefined;
     }
 }
 /**
  * Represents a single Lyric stream within a {@link MediaPart}.
  */
 export class LyricStream extends MediaPartStream {
-    static { this.TAG = 'Stream'; }
-    static { this.STREAMTYPE = 4; }
+    static TAG = 'Stream';
+    static STREAMTYPE = 4;
     _loadData(data) {
         super._loadData(data);
         this.format = data.format;
-        this.minLines = data.minLines ? parseInt(data.minLines, 10) : undefined;
+        this.minLines = data.minLines ? Number.parseInt(data.minLines, 10) : undefined;
         this.provider = data.provider;
-        this.timed = Boolean(parseInt(data.timed ?? '0', 10));
+        this.timed = Boolean(Number.parseInt(data.timed ?? '0', 10));
     }
 }
 /**
  * Represents a single Role (actor/actress) media tag.
  */
 export class Role extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'role';
-    }
-    static { this.TAG = 'Role'; }
+    static TAG = 'Role';
+    FILTER = 'role';
 }
 /**
  * Represents a single Genre media tag.
  */
 export class Genre extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'genre';
-    }
-    static { this.TAG = 'Genre'; }
+    static TAG = 'Genre';
+    FILTER = 'genre';
 }
 /**
  * Represents a single Country media tag.
  */
 export class Country extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'country';
-    }
-    static { this.TAG = 'Country'; }
+    static TAG = 'Country';
+    FILTER = 'country';
 }
 /**
  * Represents a single Writer media tag.
  */
 export class Writer extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'writer';
-    }
-    static { this.TAG = 'Writer'; }
+    static TAG = 'Writer';
+    FILTER = 'writer';
 }
 /**
  * Represents a single Director media tag.
  */
 export class Director extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'director';
-    }
-    static { this.TAG = 'Director'; }
+    static TAG = 'Director';
+    FILTER = 'director';
 }
 export class Similar extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'similar';
-    }
-    static { this.TAG = 'Similar'; }
+    static TAG = 'Similar';
+    FILTER = 'similar';
 }
 export class Producer extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'producer';
-    }
-    static { this.TAG = 'Producer'; }
+    static TAG = 'Producer';
+    FILTER = 'producer';
 }
 export class Marker extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'marker';
-    }
-    static { this.TAG = 'Marker'; }
+    static TAG = 'Marker';
+    FILTER = 'marker';
     _loadData(data) {
         this.type = data.type;
         this.startTimeOffset = data.startTimeOffset;
@@ -235,11 +212,8 @@ export class Marker extends MediaTag {
  * Represents a single Chapter media tag.
  */
 export class Chapter extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'chapter';
-    }
-    static { this.TAG = 'Chapter'; }
+    static TAG = 'Chapter';
+    FILTER = 'chapter';
     _loadData(data) {
         this.startTimeOffset = data.startTimeOffset;
         this.endTimeOffset = data.endTimeOffset;
@@ -250,46 +224,31 @@ export class Chapter extends MediaTag {
  * Represents a single Collection media tag.
  */
 export class Collection extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'collection';
-    }
-    static { this.TAG = 'Collection'; }
+    static TAG = 'Collection';
+    FILTER = 'collection';
 }
 /** Represents a single Label media tag. */
 export class Label extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'label';
-    }
-    static { this.TAG = 'Label'; }
+    static TAG = 'Label';
+    FILTER = 'label';
 }
 /** Represents a single Style media tag. */
 export class Style extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'style';
-    }
-    static { this.TAG = 'Style'; }
+    static TAG = 'Style';
+    FILTER = 'style';
 }
 /** Represents a single Format media tag. */
 export class Format extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'format';
-    }
-    static { this.TAG = 'Format'; }
+    static TAG = 'Format';
+    FILTER = 'format';
 }
 /** Represents a single Subformat media tag. */
 export class Subformat extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'subformat';
-    }
-    static { this.TAG = 'Subformat'; }
+    static TAG = 'Subformat';
+    FILTER = 'subformat';
 }
 export class Optimized extends PlexObject {
-    static { this.TAG = 'Item'; }
+    static TAG = 'Item';
     // TODO: Implement items()
     /**
      * Remove this Optimized item.
@@ -332,13 +291,13 @@ class GuidTag extends PlexObject {
     }
 }
 export class Guid extends GuidTag {
-    static { this.TAG = 'Guid'; }
+    static TAG = 'Guid';
 }
 /**
  * Represents a single Rating media tag.
  */
 export class Rating extends PlexObject {
-    static { this.TAG = 'Rating'; }
+    static TAG = 'Rating';
     _loadData(data) {
         this.image = data.image;
         this.type = data.type;
@@ -380,26 +339,61 @@ class BaseResource extends PlexObject {
  * Represents a single Art object.
  */
 export class Art extends BaseResource {
-    static { this.TAG = 'Art'; }
+    static TAG = 'Art';
 }
 /**
  * Represents a single Poster object.
  */
 export class Poster extends BaseResource {
-    static { this.TAG = 'Photo'; }
+    static TAG = 'Photo';
 }
 /**
  * Represents a single Theme object.
  */
 export class Theme extends BaseResource {
-    static { this.TAG = 'Theme'; }
+    static TAG = 'Theme';
 }
 /**
  * Represents a single Audio stream within a {@link MediaPart}.
  */
 export class AudioStream extends MediaPartStream {
-    static { this.TAG = 'Stream'; }
-    static { this.STREAMTYPE = 2; }
+    static TAG = 'Stream';
+    static STREAMTYPE = 2;
+    /** The audio channel layout of the audio stream (ex: 5.1(side)). */
+    audioChannelLayout;
+    /** The bit depth of the audio stream (ex: 16). */
+    bitDepth;
+    /** The bitrate mode of the audio stream (ex: cbr). */
+    bitrateMode;
+    /** The number of audio channels of the audio stream (ex: 6). */
+    channels;
+    /** The duration of audio stream in milliseconds. */
+    duration;
+    /** The profile of the audio stream. */
+    profile;
+    /** The sampling rate of the audio stream (ex: 48000) */
+    samplingRate;
+    /** The stream identifier of the audio stream. */
+    streamIdentifier;
+    // Track only attributes
+    /** The gain for the album. */
+    albumGain;
+    /** The peak for the album. */
+    albumPeak;
+    /** The range for the album. */
+    albumRange;
+    /** The end ramp for the track. */
+    endRamp;
+    /** The gain for the track. */
+    gain;
+    /** The loudness for the track. */
+    loudness;
+    /** The lra for the track. */
+    lra;
+    /** The peak for the track. */
+    peak;
+    /** The start ramp for the track. */
+    startRamp;
     /**
      * Sets this audio stream as the selected audio stream.
      * Alias for {@link MediaPart.setSelectedAudioStream}.
@@ -414,29 +408,31 @@ export class AudioStream extends MediaPartStream {
     _loadData(data) {
         super._loadData(data);
         this.audioChannelLayout = data.audioChannelLayout;
-        this.bitDepth = data.bitDepth ? parseInt(data.bitDepth, 10) : undefined;
+        this.bitDepth = data.bitDepth ? Number.parseInt(data.bitDepth, 10) : undefined;
         this.bitrateMode = data.bitrateMode;
-        this.channels = data.channels ? parseInt(data.channels, 10) : undefined;
-        this.duration = data.duration ? parseInt(data.duration, 10) : undefined;
+        this.channels = data.channels ? Number.parseInt(data.channels, 10) : undefined;
+        this.duration = data.duration ? Number.parseInt(data.duration, 10) : undefined;
         this.profile = data.profile;
-        this.samplingRate = data.samplingRate ? parseInt(data.samplingRate, 10) : undefined;
-        this.streamIdentifier = data.streamIdentifier ? parseInt(data.streamIdentifier, 10) : undefined;
-        this.visualImpaired = Boolean(parseInt(data.visualImpaired ?? '0', 10));
+        this.samplingRate = data.samplingRate ? Number.parseInt(data.samplingRate, 10) : undefined;
+        this.streamIdentifier = data.streamIdentifier
+            ? Number.parseInt(data.streamIdentifier, 10)
+            : undefined;
+        this.visualImpaired = Boolean(Number.parseInt(data.visualImpaired ?? '0', 10));
         // Track only attributes
-        this.albumGain = data.albumGain ? parseFloat(data.albumGain) : undefined;
-        this.albumPeak = data.albumPeak ? parseFloat(data.albumPeak) : undefined;
-        this.albumRange = data.albumRange ? parseFloat(data.albumRange) : undefined;
+        this.albumGain = data.albumGain ? Number.parseFloat(data.albumGain) : undefined;
+        this.albumPeak = data.albumPeak ? Number.parseFloat(data.albumPeak) : undefined;
+        this.albumRange = data.albumRange ? Number.parseFloat(data.albumRange) : undefined;
         this.endRamp = data.endRamp;
-        this.gain = data.gain ? parseFloat(data.gain) : undefined;
-        this.loudness = data.loudness ? parseFloat(data.loudness) : undefined;
-        this.lra = data.lra ? parseFloat(data.lra) : undefined;
-        this.peak = data.peak ? parseFloat(data.peak) : undefined;
+        this.gain = data.gain ? Number.parseFloat(data.gain) : undefined;
+        this.loudness = data.loudness ? Number.parseFloat(data.loudness) : undefined;
+        this.lra = data.lra ? Number.parseFloat(data.lra) : undefined;
+        this.peak = data.peak ? Number.parseFloat(data.peak) : undefined;
         this.startRamp = data.startRamp;
     }
 }
 /** Represents a single Image media tag. */
 export class Image extends PlexObject {
-    static { this.TAG = 'Image'; }
+    static TAG = 'Image';
     _loadData(data) {
         this.alt = data.alt;
         this.type = data.type;
@@ -446,7 +442,7 @@ export class Image extends PlexObject {
 }
 /** Represents a single Field. */
 export class Field extends PlexObject {
-    static { this.TAG = 'Field'; }
+    static TAG = 'Field';
     _loadData(data) {
         // Convert potential string '1' or '0' to boolean
         this.locked = data.locked === '1' || data.locked === true;
@@ -455,9 +451,6 @@ export class Field extends PlexObject {
 }
 /** Represents a single Mood media tag. */
 export class Mood extends MediaTag {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'mood';
-    }
-    static { this.TAG = 'Mood'; }
+    static TAG = 'Mood';
+    FILTER = 'mood';
 }