@ctrl/plex 3.10.0 → 3.12.0

package/dist/src/myplex.js

@@ -13,7 +13,13 @@ import { PlexServer } from './server.js';
  * and return this object.
  */
 export class MyPlexAccount {
-    static { this.key = 'https://plex.tv/api/v2/user'; }
+    baseUrl;
+    username;
+    password;
+    token;
+    timeout;
+    server;
+    static key = 'https://plex.tv/api/v2/user';
     /**
      * This follows the outline described in https://forums.plex.tv/t/authenticating-with-plex/609370
      * to fetch a token and potentially compromise username and password. To use first call `getWebLogin()`
@@ -37,7 +43,7 @@ export class MyPlexAccount {
         });
         return {
             ...pin,
-            uri: `https://app.plex.tv/auth#?clientID=${encodeURIComponent(clientIdentifier)}&code=${encodeURIComponent(pin.code)}&context%5Bdevice%5D%5Bproduct%5D=${encodeURIComponent(appName)}${forwardUrl ? '&forwardUrl=' + encodeURIComponent(forwardUrl) : ''}`,
+            uri: `https://app.plex.tv/auth#?clientID=${encodeURIComponent(clientIdentifier)}&code=${encodeURIComponent(pin.code)}&context%5Bdevice%5D%5Bproduct%5D=${encodeURIComponent(appName)}${forwardUrl ? `&forwardUrl=${encodeURIComponent(forwardUrl)}` : ''}`,
         };
     }
     /**
@@ -79,6 +85,18 @@ export class MyPlexAccount {
         }
         throw new Error('Failed to authenticate before timeout');
     }
+    FRIENDINVITE = 'https://plex.tv/api/servers/{machineId}/shared_servers'; // post with data
+    HOMEUSERCREATE = 'https://plex.tv/api/home/users?title={title}'; // post with data
+    EXISTINGUSER = 'https://plex.tv/api/home/users?invitedEmail={username}'; // post with data
+    FRIENDSERVERS = 'https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}'; // put with data
+    PLEXSERVERS = 'https://plex.tv/api/servers/{machineId}'; // get
+    FRIENDUPDATE = 'https://plex.tv/api/friends/{userId}'; // put with args, delete
+    REMOVEHOMEUSER = 'https://plex.tv/api/home/users/{userId}'; // delete
+    REMOVEINVITE = 'https://plex.tv/api/invites/requested/{userId}?friend=0&server=1&home=0'; // delete
+    REQUESTED = 'https://plex.tv/api/invites/requested'; // get
+    REQUESTS = 'https://plex.tv/api/invites/requests'; // get
+    SIGNIN = 'https://plex.tv/users/sign_in.json'; // get with auth
+    WEBHOOKS = 'https://plex.tv/api/v2/user/webhooks'; // get, post with data
     /**
      *
      * @param username Your MyPlex username
@@ -95,18 +113,6 @@ export class MyPlexAccount {
         this.token = token;
         this.timeout = timeout;
         this.server = server;
-        this.FRIENDINVITE = 'https://plex.tv/api/servers/{machineId}/shared_servers'; // post with data
-        this.HOMEUSERCREATE = 'https://plex.tv/api/home/users?title={title}'; // post with data
-        this.EXISTINGUSER = 'https://plex.tv/api/home/users?invitedEmail={username}'; // post with data
-        this.FRIENDSERVERS = 'https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}'; // put with data
-        this.PLEXSERVERS = 'https://plex.tv/api/servers/{machineId}'; // get
-        this.FRIENDUPDATE = 'https://plex.tv/api/friends/{userId}'; // put with args, delete
-        this.REMOVEHOMEUSER = 'https://plex.tv/api/home/users/{userId}'; // delete
-        this.REMOVEINVITE = 'https://plex.tv/api/invites/requested/{userId}?friend=0&server=1&home=0'; // delete
-        this.REQUESTED = 'https://plex.tv/api/invites/requested'; // get
-        this.REQUESTS = 'https://plex.tv/api/invites/requests'; // get
-        this.SIGNIN = 'https://plex.tv/users/sign_in.json'; // get with auth
-        this.WEBHOOKS = 'https://plex.tv/api/v2/user/webhooks'; // get, post with data
         if (this.token) {
             Object.defineProperty(this, 'token', {
                 enumerable: false,
@@ -214,7 +220,7 @@ export class MyPlexAccount {
      */
     async claimToken() {
         const url = 'https://plex.tv/api/claim/token.json';
-        const response = await this.query(url, 'get', undefined);
+        const response = await this.query(url, 'get');
         return response.token;
     }
     /**
@@ -292,11 +298,13 @@ async function connect(cls, url, token, timeout) {
  * content such as Plex Media Servers, iPhone or Android clients, etc.
  */
 export class MyPlexResource {
-    static { this.key = 'https://plex.tv/api/v2/resources?includeHttps=1&includeRelay=1'; }
+    account;
+    baseUrl;
+    static key = 'https://plex.tv/api/v2/resources?includeHttps=1&includeRelay=1';
+    TAG = 'Device';
     constructor(account, data, baseUrl = null) {
         this.account = account;
         this.baseUrl = baseUrl;
-        this.TAG = 'Device';
         this._loadData(data);
     }
     async connect(ssl = null, timeout) {
@@ -354,8 +362,8 @@ export class MyPlexResource {
     }
 }
 export class ResourceConnection {
+    TAG = 'Connection';
     constructor(data) {
-        this.TAG = 'Connection';
         this._loadData(data);
     }
     _loadData(data) {
@@ -374,8 +382,8 @@ export class ResourceConnection {
  * https://plex.tv/devices.xml
  */
 export class MyPlexDevice extends PlexObject {
-    static { this.TAG = 'Device'; }
-    static { this.key = 'https://plex.tv/devices.xml'; }
+    static TAG = 'Device';
+    static key = 'https://plex.tv/devices.xml';
     async connect() {
         // TODO: switch between PlexServer and PlexClient
         // Try connecting to all known resource connections in parellel, but
@@ -414,8 +422,8 @@ export class MyPlexDevice extends PlexObject {
         });
         this.screenResolution = data.$.screenResolution;
         this.screenDensity = data.$.screenDensity;
-        this.createdAt = new Date(parseInt(data.$.createdAt, 10));
-        this.lastSeenAt = new Date(parseInt(data.$.lastSeenAt, 10));
+        this.createdAt = new Date(Number.parseInt(data.$.createdAt, 10));
+        this.lastSeenAt = new Date(Number.parseInt(data.$.lastSeenAt, 10));
         this.connections = data.Connection?.map(connection => connection.$.uri);
     }
 }

package/dist/src/playlist.js

@@ -1,4 +1,4 @@
-import { URLSearchParams } from 'url';
+import { URLSearchParams } from 'node:url';
 import { Playable } from './base/playable.js';
 import { Album, Artist, Track } from './audio.js';
 import { fetchItems } from './baseFunctionality.js';
@@ -9,28 +9,28 @@ import { Episode, Movie } from './video.js';
  */
 function contentClass(data) {
     switch (data.type) {
-        case 'episode':
+        case 'episode': {
             return Episode;
-        case 'movie':
+        }
+        case 'movie': {
             return Movie;
-        case 'track':
+        }
+        case 'track': {
             return Track;
-        case 'album':
+        }
+        case 'album': {
             return Album;
-        case 'artist':
+        }
+        case 'artist': {
             return Artist;
-        default:
+        }
+        default: {
             throw new Error(`Media type '${data.type}' not implemented`);
+        }
     }
 }
 export class Playlist extends Playable {
-    constructor() {
-        super(...arguments);
-        this.TYPE = 'playlist';
-        /** Cache of playlist items */
-        this._items = null;
-    }
-    static { this.TAG = 'Playlist'; }
+    static TAG = 'Playlist';
     static async create(server, title, options) {
         if (options.smart) {
             throw new Error('not yet supported');
@@ -86,6 +86,9 @@ export class Playlist extends Playable {
         const data = await server.query(key, 'post');
         return new Playlist(server, data.MediaContainer.Metadata[0], key);
     }
+    TYPE = 'playlist';
+    /** Cache of playlist items */
+    _items = null;
     async _edit(args) {
         const searchparams = new URLSearchParams(args);
         const key = `${this.key}?${searchparams.toString()}`;
@@ -99,7 +102,7 @@ export class Playlist extends Playable {
      */
     async item(title) {
         const items = await this.items();
-        const matched = items.find(item => item.title.toLowerCase() === title.toLowerCase());
+        const matched = items.find(item => item.title?.toLowerCase() === title.toLowerCase());
         return matched ?? null;
     }
     async items() {

package/dist/src/playqueue.js

@@ -9,13 +9,10 @@ import { BadRequest } from './exceptions.js';
  * removing, and reordering items.
  */
 export class PlayQueue extends PlexObject {
-    constructor() {
-        super(...arguments);
-        /** Cache of PlayQueue items */
-        this._items = null;
-    }
-    static { this.TAG = 'PlayQueue'; }
-    static { this.TYPE = 'playqueue'; }
+    static TAG = 'PlayQueue';
+    static TYPE = 'playqueue';
+    /** Cache of PlayQueue items */
+    _items = null;
     /**
      * Retrieve an existing PlayQueue by identifier.
      */
@@ -258,7 +255,7 @@ export class PlayQueue extends PlexObject {
         this.playQueueSourceURI = data.playQueueSourceURI;
         this.playQueueTotalCount = data.playQueueTotalCount;
         this.playQueueVersion = data.playQueueVersion;
-        this.size = data.size || this.playQueueTotalCount;
+        this.size = data.size > 0 ? data.size : this.playQueueTotalCount;
         // selectedItem will be set lazily when accessing items
     }
     _invalidateCacheAndLoadData(data) {

package/dist/src/search.js

@@ -1,7 +1,7 @@
 import { PlexObject } from './base/plexObject.js';
 import { rsplit } from './util.js';
 export class SearchResult extends PlexObject {
-    static { this.TAG = 'SearchResult'; }
+    static TAG = 'SearchResult';
     _loadData(data) {
         this.guid = data.guid;
         this.lifespanEnded = data.lifespanEnded;
@@ -14,7 +14,7 @@ export class SearchResult extends PlexObject {
  * Represents a single Agent
  */
 export class Agent extends PlexObject {
-    static { this.TAG = 'Agent'; }
+    static TAG = 'Agent';
     // languageCode: any[] = [];
     _loadData(data) {
         this.hasAttribution = data.hasAttribution;

package/dist/src/server.d.ts

@@ -1,4 +1,4 @@
-import { URL, URLSearchParams } from 'url';
+import { URL, URLSearchParams } from 'node:url';
 import { Playable } from './base/playable.js';
 import { PlexClient } from './client.js';
 import { Hub, Library } from './library.js';

package/dist/src/server.js

@@ -1,5 +1,5 @@
+import { URL, URLSearchParams } from 'node:url';
 import { ofetch } from 'ofetch';
-import { URL, URLSearchParams } from 'url';
 import { fetchItem, fetchItems } from './baseFunctionality.js';
 import { PlexClient } from './client.js';
 import { BASE_HEADERS, TIMEOUT, X_PLEX_CONTAINER_SIZE } from './config.js';
@@ -17,6 +17,13 @@ import { Settings } from './settings.js';
  * can also create an PlexServer instance from :class:`~plexapi.myplex.MyPlexAccount`.
  */
 export class PlexServer {
+    baseurl;
+    token;
+    timeout;
+    key = '/';
+    _library;
+    _settings;
+    _myPlexAccount;
     constructor(baseurl, token, 
     /**
      * Default request timeout in milliseconds.
@@ -26,7 +33,6 @@ export class PlexServer {
         this.baseurl = baseurl;
         this.token = token;
         this.timeout = timeout;
-        this.key = '/';
     }
     async agents(mediaType) {
         let key = '/system/agents';
@@ -87,7 +93,7 @@ export class PlexServer {
         if (limit) {
             params.limit = limit.toString();
         }
-        const key = '/hubs/search?' + new URLSearchParams(params).toString();
+        const key = `/hubs/search?${new URLSearchParams(params).toString()}`;
         const hubs = await fetchItems(this, key, undefined, Hub, this);
         return hubs;
     }
@@ -131,7 +137,7 @@ export class PlexServer {
      * @param accountId request history for a specific account ID.
      * @param librarySectionId request history for a specific library section ID.
      */
-    async history(maxresults = 9999999, mindate, ratingKey, accountId, librarySectionId) {
+    async history(maxresults = 9_999_999, mindate, ratingKey, accountId, librarySectionId) {
         const args = { sort: 'viewedAt:desc' };
         if (ratingKey !== undefined) {
             args.metadataItemID = ratingKey.toString();
@@ -148,21 +154,21 @@ export class PlexServer {
         args['X-Plex-Container-Start'] = '0';
         args['X-Plex-Container-Size'] = Math.min(X_PLEX_CONTAINER_SIZE, maxresults).toString();
         let results = [];
-        let key = '/status/sessions/history/all?' + new URLSearchParams(args).toString();
+        let key = `/status/sessions/history/all?${new URLSearchParams(args).toString()}`;
         let raw = await this.query(key);
         const totalResults = raw.MediaContainer.totalSize;
         // Filter out null/undefined items from the metadata
         const validMetadata = raw.MediaContainer.Metadata?.filter(Boolean) ?? [];
-        results = results.concat(validMetadata);
+        results.push(...validMetadata);
         while (results.length <= totalResults &&
             X_PLEX_CONTAINER_SIZE === raw.MediaContainer.size &&
             maxresults > results.length) {
             args['X-Plex-Container-Start'] = (Number(args['X-Plex-Container-Start']) + Number(args['X-Plex-Container-Size'])).toString();
-            key = '/status/sessions/history/all?' + new URLSearchParams(args).toString();
+            key = `/status/sessions/history/all?${new URLSearchParams(args).toString()}`;
             raw = await this.query(key);
             // Filter out null/undefined items from the metadata
             const validMetadata = raw.MediaContainer.Metadata?.filter(item => item != null) ?? [];
-            results = results.concat(validMetadata);
+            results.push(...validMetadata);
         }
         return results;
     }

package/dist/src/settings.js

@@ -1,4 +1,4 @@
-import { URLSearchParams } from 'url';
+import { URLSearchParams } from 'node:url';
 import { PlexObject } from './base/plexObject.js';
 import { NotFound } from './exceptions.js';
 import { lowerFirst } from './util.js';
@@ -22,11 +22,8 @@ var Type;
     Type["Text"] = "text";
 })(Type || (Type = {}));
 export class Settings extends PlexObject {
-    constructor() {
-        super(...arguments);
-        this._data = [];
-    }
-    static { this.key = '/:/prefs'; }
+    static key = '/:/prefs';
+    _data = [];
     all() {
         return Object.entries(this._settings)
             .sort((a, b) => a[0].localeCompare(b[0]))
@@ -70,17 +67,14 @@ export class Settings extends PlexObject {
  * Represents a single Plex setting
  */
 export class Setting extends PlexObject {
-    constructor() {
-        super(...arguments);
-        this._setValue = null;
-    }
+    _setValue = null;
     /**
      * Set a new value for this setitng. NOTE: You must call {@link Settings.save} before
      * any changes to setting values are persisted to the PlexServer.
      */
     set(value) {
         if (typeof value !== typeof this.value) {
-            throw new Error('Invalid type');
+            throw new TypeError('Invalid type');
         }
         this._setValue = value;
     }
@@ -99,11 +93,8 @@ export class Setting extends PlexObject {
     }
 }
 export class Preferences extends Setting {
-    constructor() {
-        super(...arguments);
-        this.FILTER = 'preferences';
-    }
-    static { this.TAG = 'Preferences'; }
+    static TAG = 'Preferences';
+    FILTER = 'preferences';
 }
 // class Setting(PlexObject):
 //     """ Represents a single Plex setting.

package/dist/src/util.d.ts

@@ -10,11 +10,11 @@ export interface MetadataContainer<T extends {
 export declare function rsplit(str: string, sep: string, maxsplit: number): string[];
 /**
  * Return the full agent identifier from a short identifier, name, or confirm full identifier.
- * @param section
- * @param agent
  */
 export declare function getAgentIdentifier(section: Section, agent: string): Promise<string>;
-/** Simple tag helper for editing a object. */
+/**
+ * Simple tag helper for editing a object.
+ */
 export declare function tagHelper(tag: string, items: string[], locked?: boolean, remove?: boolean): Record<string, string | number>;
 export declare function ltrim(x: string, characters: string[]): string;
 export declare function lowerFirst(str: string): string;

package/dist/src/util.js

@@ -1,11 +1,12 @@
 export function rsplit(str, sep, maxsplit) {
     const split = str.split(sep);
-    return maxsplit ? [split.slice(0, -maxsplit).join(sep)].concat(split.slice(-maxsplit)) : split;
+    if (maxsplit) {
+        return [split.slice(0, -maxsplit).join(sep), ...split.slice(-maxsplit)];
+    }
+    return split;
 }
 /**
  * Return the full agent identifier from a short identifier, name, or confirm full identifier.
- * @param section
- * @param agent
  */
 export async function getAgentIdentifier(section, agent) {
     const agents = [];
@@ -14,11 +15,13 @@ export async function getAgentIdentifier(section, agent) {
         if (identifiers.includes(agent)) {
             return ag.identifier;
         }
-        agents.concat(identifiers);
+        agents.push(...identifiers);
     }
     throw new Error(`Couldnt find "${agent}" in agents list (${agents.join(', ')})`);
 }
-/** Simple tag helper for editing a object. */
+/**
+ * Simple tag helper for editing a object.
+ */
 export function tagHelper(tag, items, locked = true, remove = false) {
     const data = {};
     if (remove) {
@@ -40,9 +43,8 @@ export function ltrim(x, characters) {
     while (characters.includes(x[start])) {
         start += 1;
     }
-    const end = x.length - 1;
-    return x.substr(start, end);
+    return x.slice(start);
 }
 export function lowerFirst(str) {
-    return str.charAt(0).toUpperCase() + str.slice(1);
+    return str.charAt(0).toLowerCase() + str.slice(1);
 }

package/dist/src/video.d.ts

@@ -1,4 +1,4 @@
-import type { URL } from 'url';
+import type { URL } from 'node:url';
 import { Playable } from './base/playable.js';
 import type { ExtrasData, FullShowData, MovieData, ShowData } from './library.types.js';
 import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, Poster, Producer, Rating, Role, Similar, Writer } from './media.js';

package/dist/src/video.js

@@ -2,11 +2,8 @@ import { Playable } from './base/playable.js';
 import { fetchItem, fetchItems, findItems } from './baseFunctionality.js';
 import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, Poster, Producer, Rating, Role, Similar, Writer, } from './media.js';
 class Video extends Playable {
-    constructor() {
-        super(...arguments);
-        /** Hardcoded as 'video' (useful for search filters). */
-        this.listType = 'video';
-    }
+    /** Hardcoded as 'video' (useful for search filters). */
+    listType = 'video';
     /**
      * Returns True if this video is watched.
      */
@@ -109,12 +106,9 @@ class Video extends Playable {
  * Represents a single Movie.
  */
 export class Movie extends Video {
-    constructor() {
-        super(...arguments);
-        this.TAG = 'Video';
-        this.TYPE = 'movie';
-        this.METADATA_TYPE = 'movie';
-    }
+    TAG = 'Video';
+    TYPE = 'movie';
+    METADATA_TYPE = 'movie';
     get actors() {
         return this.roles;
     }
@@ -190,12 +184,9 @@ export class Movie extends Video {
  * Represents a single Show (including all seasons and episodes).
  */
 export class Show extends Video {
-    constructor() {
-        super(...arguments);
-        this.TAG = 'Directory';
-        this.TYPE = 'show';
-        this.METADATA_TYPE = 'episode';
-    }
+    TAG = 'Directory';
+    TYPE = 'show';
+    METADATA_TYPE = 'episode';
     /** <:class:`~plexapi.media.Similar`>): List of Similar objects. */
     // similar: List;
     /**
@@ -256,12 +247,9 @@ export class Show extends Video {
  * Represents a single Show Season (including all episodes).
  */
 export class Season extends Video {
-    constructor() {
-        super(...arguments);
-        this.TAG = 'Directory';
-        this.TYPE = 'season';
-        this.METADATA_TYPE = 'episode';
-    }
+    TAG = 'Directory';
+    TYPE = 'season';
+    METADATA_TYPE = 'episode';
     /** Returns season number */
     get seasonNumber() {
         return this.index;
@@ -290,12 +278,9 @@ export class Season extends Video {
     }
 }
 export class Episode extends Video {
-    constructor() {
-        super(...arguments);
-        this.TYPE = 'episode';
-        this.METADATA_TYPE = 'episode';
-    }
-    static { this.TAG = 'Video'; }
+    static TAG = 'Video';
+    TYPE = 'episode';
+    METADATA_TYPE = 'episode';
     /**
      * Returns this episodes season number.
      */
@@ -380,12 +365,9 @@ export class Episode extends Video {
     }
 }
 export class Clip extends Video {
-    constructor() {
-        super(...arguments);
-        this.TYPE = 'clip';
-        this.METADATA_TYPE = 'clip';
-    }
-    static { this.TAG = 'Video'; }
+    static TAG = 'Video';
+    TYPE = 'clip';
+    METADATA_TYPE = 'clip';
     _loadData(data) {
         super._loadData(data);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/plex",
-  "version": "3.10.0",
+  "version": "3.12.0",
   "description": "plex api client in typescript using ofetch",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "publishConfig": {
@@ -34,33 +34,33 @@
   },
   "dependencies": {
     "@ctrl/mac-address": "^3.1.0",
-    "ofetch": "^1.4.1",
+    "ofetch": "^1.5.1",
     "p-any": "^4.0.0",
-    "type-fest": "^5.0.1",
+    "type-fest": "^5.3.1",
     "ws": "^8.18.3",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@ctrl/oxlint-config": "1.2.8",
+    "@ctrl/oxlint-config": "1.3.3",
     "@ctrl/video-filename-parser": "5.4.1",
-    "@sindresorhus/tsconfig": "8.0.1",
-    "@trivago/prettier-plugin-sort-imports": "5.2.2",
-    "@types/node": "24.7.2",
+    "@sindresorhus/tsconfig": "8.1.0",
+    "@trivago/prettier-plugin-sort-imports": "6.0.0",
+    "@types/node": "25.0.3",
     "@types/ws": "8.18.1",
     "@types/xml2js": "0.4.14",
-    "@types/yargs": "17.0.33",
-    "@vitest/coverage-v8": "3.2.4",
-    "execa": "9.6.0",
-    "globby": "15.0.0",
+    "@types/yargs": "17.0.35",
+    "@vitest/coverage-v8": "4.0.16",
+    "execa": "9.6.1",
+    "globby": "16.1.0",
     "make-dir": "5.1.0",
     "ora": "9.0.0",
-    "oxlint": "1.22.0",
-    "p-retry": "7.1.0",
-    "prettier": "3.6.2",
-    "tsx": "4.20.6",
-    "typedoc": "0.28.14",
+    "oxlint": "1.35.0",
+    "p-retry": "7.1.1",
+    "prettier": "3.7.4",
+    "tsx": "4.21.0",
+    "typedoc": "0.28.15",
     "typescript": "5.9.3",
-    "vitest": "3.2.4",
+    "vitest": "4.0.16",
     "yargs": "18.0.0"
   },
   "release": {
@@ -91,5 +91,5 @@
   "engines": {
     "node": ">=18"
   },
-  "packageManager": "pnpm@10.18.2"
+  "packageManager": "pnpm@10.26.1"
 }