@ctrl/plex 3.5.0 → 3.6.1

package/dist/src/base/partialPlexObject.js

@@ -6,25 +6,25 @@ export class PartialPlexObject extends PlexObject {
     constructor() {
         super(...arguments);
         this._INCLUDES = {
-            checkFiles: 1,
-            includeAllConcerts: 1,
+            checkFiles: 0,
+            includeAllConcerts: 0,
             includeBandwidths: 1,
             includeChapters: 1,
-            includeChildren: 1,
-            includeConcerts: 1,
-            includeExternalMedia: 1,
-            includeExtras: 1,
+            includeChildren: 0,
+            includeConcerts: 0,
+            includeExternalMedia: 0,
+            includeExtras: 0,
             includeFields: 'thumbBlurHash,artBlurHash',
             includeGeolocation: 1,
             includeLoudnessRamps: 1,
             includeMarkers: 1,
-            includeOnDeck: 1,
-            includePopularLeaves: 1,
-            includePreferences: 1,
-            includeRelated: 1,
-            includeRelatedCount: 1,
-            includeReviews: 1,
-            includeStations: 1,
+            includeOnDeck: 0,
+            includePopularLeaves: 0,
+            includePreferences: 0,
+            includeRelated: 0,
+            includeRelatedCount: 0,
+            includeReviews: 0,
+            includeStations: 0,
         };
         this._detailsKey = this._buildDetailsKey();
     }

package/dist/src/config.d.ts

@@ -23,6 +23,7 @@ export declare const BASE_HEADERS: {
     readonly 'X-Plex-Device': string;
     readonly 'X-Plex-Device-Name': string;
     readonly 'X-Plex-Client-Identifier': string;
-    readonly 'X-Plex-Sync-Version': "2";
     readonly 'X-Plex-Language': "en";
+    readonly 'X-Plex-Sync-Version': "2";
+    readonly 'X-Plex-Features': "external-media";
 };

package/dist/src/config.js

@@ -33,6 +33,7 @@ export const BASE_HEADERS = {
     'X-Plex-Device': X_PLEX_DEVICE,
     'X-Plex-Device-Name': X_PLEX_DEVICE_NAME,
     'X-Plex-Client-Identifier': X_PLEX_IDENTIFIER,
-    'X-Plex-Sync-Version': '2',
     'X-Plex-Language': 'en',
+    'X-Plex-Sync-Version': '2',
+    'X-Plex-Features': 'external-media',
 };

package/dist/src/library.d.ts

@@ -217,6 +217,10 @@ interface SearchArgs {
      * return {@link Movie} objects)
      */
     libtype: Libtype;
+    /**
+     * Return only results that have duplicates.
+     */
+    duplicate: number;
 }
 /**
  * Base class for a single library section.

package/dist/src/media.d.ts

@@ -74,6 +74,28 @@ export declare class MediaPart extends PlexObject {
     videoProfile: string;
     streams: MediaPartStream[];
     exists?: boolean;
+    /**
+     * Set the selected {@link AudioStream} for this MediaPart.
+     * @param stream Audio stream or stream ID to set as selected.
+     */
+    setSelectedAudioStream(stream: AudioStream | number): Promise<this>;
+    /**
+     * Set the selected {@link SubtitleStream} for this MediaPart.
+     * @param stream Subtitle stream or stream ID to set as selected.
+     */
+    setSelectedSubtitleStream(stream: SubtitleStream | number): Promise<this>;
+    /**
+     * Returns a list of {@link AudioStream} objects in this MediaPart.
+     */
+    audioStreams(): AudioStream[];
+    /**
+     * Returns a list of {@link SubtitleStream} objects in this MediaPart.
+     */
+    subtitleStreams(): SubtitleStream[];
+    /**
+     * Returns a list of {@link LyricStream} objects in this MediaPart.
+     */
+    lyricStreams(): LyricStream[];
     protected _loadData(data: MediaPartData): void;
 }
 export declare class MediaPartStream extends PlexObject {
@@ -87,6 +109,59 @@ export declare class MediaPartStream extends PlexObject {
     streamType?: number;
     protected _loadData(data: MediaPartStreamData): void;
 }
+/**
+ * Represents a single Subtitle stream within a {@link MediaPart}.
+ */
+export declare class SubtitleStream extends MediaPartStream {
+    static TAG: "Stream";
+    static STREAMTYPE: number;
+    /** True if the subtitle stream can be auto synced. */
+    canAutoSync?: boolean;
+    /** The container of the subtitle stream. */
+    container?: string;
+    /** True if this is a forced subtitle. */
+    forced: boolean;
+    /** The format of the subtitle stream (ex: srt). */
+    format?: string;
+    /** The header compression of the subtitle stream. */
+    headerCompression?: string;
+    /** True if this is a hearing impaired (SDH) subtitle. */
+    hearingImpaired: boolean;
+    /** True if the on-demand subtitle is a perfect match. */
+    perfectMatch?: boolean;
+    /** The provider title where the on-demand subtitle is downloaded from. */
+    providerTitle?: string;
+    /** The match score (download count) of the on-demand subtitle. */
+    score?: number;
+    /** The source key of the on-demand subtitle. */
+    sourceKey?: string;
+    /** Unknown. */
+    transient?: string;
+    /** The user id of the user that downloaded the on-demand subtitle. */
+    userID?: number;
+    /**
+     * Sets this subtitle stream as the selected subtitle stream.
+     * Alias for `MediaPart.setSelectedSubtitleStream`.
+     */
+    setSelected(): Promise<void>;
+    protected _loadData(data: any): void;
+}
+/**
+ * Represents a single Lyric stream within a {@link MediaPart}.
+ */
+export declare class LyricStream extends MediaPartStream {
+    static TAG: "Stream";
+    static STREAMTYPE: number;
+    /** The format of the lyric stream (ex: lrc). */
+    format?: string;
+    /** The minimum number of lines in the (timed) lyric stream. */
+    minLines?: number;
+    /** The provider of the lyric stream (ex: com.plexapp.agents.lyricfind). */
+    provider?: string;
+    /** True if the lyrics are timed to the track. */
+    timed: boolean;
+    protected _loadData(data: any): void;
+}
 /**
  * Represents a single Role (actor/actress) media tag.
  */
@@ -164,6 +239,20 @@ export declare class Optimized extends PlexObject {
     type: any;
     target: any;
     targetTagID: any;
+    /**
+     * Remove this Optimized item.
+     */
+    remove(): Promise<void>;
+    /**
+     * Rename this Optimized item.
+     * @param title New title for the item.
+     */
+    rename(title: string): Promise<void>;
+    /**
+     * Reprocess a removed Conversion item that is still a listed Optimize item.
+     * @param ratingKey The rating key of the item to reprocess.
+     */
+    reprocess(ratingKey: string | number): Promise<void>;
     protected _loadData(data: any): void;
 }
 /**
@@ -242,4 +331,53 @@ export declare class Poster extends BaseResource {
 export declare class Theme extends BaseResource {
     static TAG: string;
 }
+/**
+ * Represents a single Audio stream within a {@link MediaPart}.
+ */
+export declare class AudioStream extends MediaPartStream {
+    static TAG: "Stream";
+    static STREAMTYPE: number;
+    /** The audio channel layout of the audio stream (ex: 5.1(side)). */
+    audioChannelLayout?: string;
+    /** The bit depth of the audio stream (ex: 16). */
+    bitDepth?: number;
+    /** The bitrate mode of the audio stream (ex: cbr). */
+    bitrateMode?: string;
+    /** The number of audio channels of the audio stream (ex: 6). */
+    channels?: number;
+    /** The duration of audio stream in milliseconds. */
+    duration?: number;
+    /** The profile of the audio stream. */
+    profile?: string;
+    /** The sampling rate of the audio stream (ex: 48000) */
+    samplingRate?: number;
+    /** The stream identifier of the audio stream. */
+    streamIdentifier?: number;
+    /** True if this is a visually impaired (AD) audio stream. */
+    visualImpaired: boolean;
+    /** The gain for the album. */
+    albumGain?: number;
+    /** The peak for the album. */
+    albumPeak?: number;
+    /** The range for the album. */
+    albumRange?: number;
+    /** The end ramp for the track. */
+    endRamp?: string;
+    /** The gain for the track. */
+    gain?: number;
+    /** The loudness for the track. */
+    loudness?: number;
+    /** The lra for the track. */
+    lra?: number;
+    /** The peak for the track. */
+    peak?: number;
+    /** The start ramp for the track. */
+    startRamp?: string;
+    /**
+     * Sets this audio stream as the selected audio stream.
+     * Alias for {@link MediaPart.setSelectedAudioStream}.
+     */
+    setSelected(): Promise<void>;
+    protected _loadData(data: any): void;
+}
 export {};

package/dist/src/media.js

@@ -40,6 +40,48 @@ export class Media extends PlexObject {
 }
 export class MediaPart extends PlexObject {
     static { this.TAG = 'Part'; }
+    /**
+     * Set the selected {@link AudioStream} for this MediaPart.
+     * @param stream Audio stream or stream ID to set as selected.
+     */
+    async setSelectedAudioStream(stream) {
+        const key = `/library/parts/${this.id}`;
+        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');
+        return this;
+    }
+    /**
+     * Set the selected {@link SubtitleStream} for this MediaPart.
+     * @param stream Subtitle stream or stream ID to set as selected.
+     */
+    async setSelectedSubtitleStream(stream) {
+        const key = `/library/parts/${this.id}`;
+        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');
+        return this;
+    }
+    /**
+     * Returns a list of {@link AudioStream} objects in this MediaPart.
+     */
+    audioStreams() {
+        return this.streams.filter((stream) => stream instanceof AudioStream);
+    }
+    /**
+     * Returns a list of {@link SubtitleStream} objects in this MediaPart.
+     */
+    subtitleStreams() {
+        return this.streams.filter((stream) => stream instanceof SubtitleStream);
+    }
+    /**
+     * Returns a list of {@link LyricStream} objects in this MediaPart.
+     */
+    lyricStreams() {
+        return this.streams.filter((stream) => stream instanceof LyricStream);
+    }
     _loadData(data) {
         this.container = data.container;
         this.duration = data.duration;
@@ -66,6 +108,53 @@ export class MediaPartStream extends PlexObject {
         this.streamType = data.streamType;
     }
 }
+/**
+ * Represents a single Subtitle stream within a {@link MediaPart}.
+ */
+export class SubtitleStream extends MediaPartStream {
+    static { this.TAG = 'Stream'; }
+    static { this.STREAMTYPE = 3; }
+    /**
+     * Sets this subtitle stream as the selected subtitle stream.
+     * Alias for `MediaPart.setSelectedSubtitleStream`.
+     */
+    async setSelected() {
+        const parent = this.parent?.deref();
+        if (!parent) {
+            throw new Error('SubtitleStream must have a parent MediaPart');
+        }
+        await parent.setSelectedSubtitleStream(this);
+    }
+    _loadData(data) {
+        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.format = data.format;
+        this.headerCompression = data.headerCompression;
+        this.hearingImpaired = Boolean(parseInt(data.hearingImpaired ?? '0', 10));
+        this.perfectMatch = Boolean(data.perfectMatch);
+        this.providerTitle = data.providerTitle;
+        this.score = data.score ? parseInt(data.score, 10) : undefined;
+        this.sourceKey = data.sourceKey;
+        this.transient = data.transient;
+        this.userID = data.userID ? 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; }
+    _loadData(data) {
+        super._loadData(data);
+        this.format = data.format;
+        this.minLines = data.minLines ? parseInt(data.minLines, 10) : undefined;
+        this.provider = data.provider;
+        this.timed = Boolean(parseInt(data.timed ?? '0', 10));
+    }
+}
 /**
  * Represents a single Role (actor/actress) media tag.
  */
@@ -169,6 +258,30 @@ export class Collection extends MediaTag {
 }
 export class Optimized extends PlexObject {
     static { this.TAG = 'Item'; }
+    // TODO: Implement items()
+    /**
+     * Remove this Optimized item.
+     */
+    async remove() {
+        const key = `${this.key}/${this.id}`;
+        await this.server.query(key, 'delete');
+    }
+    /**
+     * Rename this Optimized item.
+     * @param title New title for the item.
+     */
+    async rename(title) {
+        const key = `${this.key}/${this.id}?Item[title]=${encodeURIComponent(title)}`;
+        await this.server.query(key, 'put');
+    }
+    /**
+     * Reprocess a removed Conversion item that is still a listed Optimize item.
+     * @param ratingKey The rating key of the item to reprocess.
+     */
+    async reprocess(ratingKey) {
+        const key = `${this.key}/${this.id}/${ratingKey}/enable`;
+        await this.server.query(key, 'put');
+    }
     _loadData(data) {
         this.id = data.id;
         this.composite = data.composite;
@@ -249,3 +362,43 @@ export class Poster extends BaseResource {
 export class Theme extends BaseResource {
     static { this.TAG = 'Theme'; }
 }
+/**
+ * Represents a single Audio stream within a {@link MediaPart}.
+ */
+export class AudioStream extends MediaPartStream {
+    static { this.TAG = 'Stream'; }
+    static { this.STREAMTYPE = 2; }
+    /**
+     * Sets this audio stream as the selected audio stream.
+     * Alias for {@link MediaPart.setSelectedAudioStream}.
+     */
+    async setSelected() {
+        const parent = this.parent?.deref();
+        if (!parent) {
+            throw new Error('AudioStream must have a parent MediaPart');
+        }
+        await parent.setSelectedAudioStream(this);
+    }
+    _loadData(data) {
+        super._loadData(data);
+        this.audioChannelLayout = data.audioChannelLayout;
+        this.bitDepth = data.bitDepth ? 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.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));
+        // 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.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.startRamp = data.startRamp;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/plex",
-  "version": "3.5.0",
+  "version": "3.6.1",
   "description": "plex api client in typescript",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "publishConfig": {
@@ -40,30 +40,31 @@
     "@ctrl/mac-address": "^3.1.0",
     "ofetch": "^1.4.1",
     "p-any": "^4.0.0",
-    "type-fest": "^4.40.1",
+    "type-fest": "^4.41.0",
     "ws": "^8.18.2",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
-    "@ctrl/eslint-config-biome": "4.4.0",
+    "@biomejs/biome": "2.0.5",
+    "@ctrl/eslint-config-biome": "5.0.0",
+    "@ctrl/video-filename-parser": "^5.2.2",
     "@sindresorhus/tsconfig": "7.0.0",
-    "@types/node": "22.15.3",
+    "@types/node": "24.0.4",
     "@types/ws": "8.18.1",
     "@types/xml2js": "0.4.14",
     "@types/yargs": "17.0.33",
-    "@vitest/coverage-v8": "3.1.2",
-    "eslint": "9.26.0",
-    "execa": "9.5.2",
+    "@vitest/coverage-v8": "3.2.4",
+    "eslint": "9.29.0",
+    "execa": "9.6.0",
     "globby": "14.1.0",
     "make-dir": "5.0.0",
     "ora": "8.2.0",
     "p-retry": "6.2.1",
     "ts-node": "10.9.2",
-    "typedoc": "0.28.3",
+    "typedoc": "0.28.5",
     "typescript": "5.8.3",
-    "vitest": "3.1.2",
-    "yargs": "17.7.2"
+    "vitest": "3.2.4",
+    "yargs": "18.0.0"
   },
   "release": {
     "branches": [
@@ -73,5 +74,5 @@
   "engines": {
     "node": ">=18"
   },
-  "packageManager": "pnpm@10.10.0"
+  "packageManager": "pnpm@10.12.4"
 }