@ctrl/plex 3.2.0 → 3.4.0

package/dist/src/alert.js

@@ -8,7 +8,6 @@ export class AlertListener {
     async run() {
         const url = this.server.url(this.key, true).toString().replace('http', 'ws');
         this._ws = new WebSocket(url);
-        // eslint-disable-next-line @typescript-eslint/ban-types
         this._ws.on('message', (buffer) => {
             try {
                 const data = JSON.parse(buffer.toString());

package/dist/src/client.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { URL } from 'url';
 import { Player } from './client.types.js';
 export interface PlexOptions {

package/dist/src/library.js

@@ -213,7 +213,6 @@ export class Library {
         const results = [];
         const sections = await this.sections();
         for (const section of sections) {
-            // eslint-disable-next-line no-await-in-loop
             const items = await section.all();
             for (const item of items) {
                 results.push(item);
@@ -227,7 +226,6 @@ export class Library {
     async emptyTrash() {
         const sections = await this.sections();
         for (const section of sections) {
-            // eslint-disable-next-line no-await-in-loop
             await section.emptyTrash();
         }
     }

package/dist/src/media.d.ts

@@ -200,4 +200,46 @@ export declare class Rating extends PlexObject {
     value: number;
     protected _loadData(data: any): void;
 }
+/**
+ * Base class for all Art, Poster, and Theme objects.
+ */
+declare abstract class BaseResource extends PlexObject {
+    /**
+     * The source of the resource. 'local' for local files (e.g. theme.mp3),
+     */
+    provider: string;
+    /**
+     * Unique key identifying the resource.
+     */
+    ratingKey: string;
+    /**
+     * True if the resource is currently selected.
+     */
+    selected: boolean;
+    /**
+     * The URL to retrieve the resource thumbnail.
+     */
+    thumb: string;
+    select(): Promise<any>;
+    resourceFilepath(): string;
+    protected _loadData(data: any): void;
+}
+/**
+ * Represents a single Art object.
+ */
+export declare class Art extends BaseResource {
+    static TAG: string;
+}
+/**
+ * Represents a single Poster object.
+ */
+export declare class Poster extends BaseResource {
+    static TAG: string;
+}
+/**
+ * Represents a single Theme object.
+ */
+export declare class Theme extends BaseResource {
+    static TAG: string;
+}
 export {};

package/dist/src/media.js

@@ -186,6 +186,7 @@ class GuidTag extends PlexObject {
         this.id = data.id;
     }
 }
+// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
 export class Guid extends GuidTag {
     static { this.TAG = 'Guid'; }
 }
@@ -200,3 +201,55 @@ export class Rating extends PlexObject {
         this.value = data.value;
     }
 }
+/**
+ * Base class for all Art, Poster, and Theme objects.
+ */
+class BaseResource extends PlexObject {
+    async select() {
+        const key = this.key.slice(0, -1);
+        const params = new URLSearchParams();
+        params.append('url', this.ratingKey);
+        return this.server.query(`${key}?${params.toString()}`, 'put');
+    }
+    resourceFilepath() {
+        if (this.ratingKey.startsWith('media://')) {
+            return `Media/localhost/${this.ratingKey.split('://')[1]}`;
+        }
+        const parent = this.parent?.deref();
+        if (this.ratingKey.startsWith('metadata://') && parent) {
+            return `${parent.metadataDirectory}/Contents/_combined/${this.ratingKey.split('://')[1]}`;
+        }
+        if (this.ratingKey.startsWith('upload://') && parent) {
+            return `${parent.metadataDirectory}/Uploads/${this.ratingKey.split('://')[1]}`;
+        }
+        return this.ratingKey;
+    }
+    _loadData(data) {
+        this.key = data.key;
+        this.provider = data.provider;
+        this.ratingKey = data.ratingKey;
+        this.selected = data.selected;
+        this.thumb = data.thumb;
+    }
+}
+/**
+ * Represents a single Art object.
+ */
+// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
+export class Art extends BaseResource {
+    static { this.TAG = 'Art'; }
+}
+/**
+ * Represents a single Poster object.
+ */
+// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
+export class Poster extends BaseResource {
+    static { this.TAG = 'Photo'; }
+}
+/**
+ * Represents a single Theme object.
+ */
+// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
+export class Theme extends BaseResource {
+    static { this.TAG = 'Theme'; }
+}

package/dist/src/myplex.d.ts

@@ -1,5 +1,5 @@
 import { PlexObject } from './base/plexObject.js';
-import { Connection, Device, ResourcesResponse } from './myplex.types.js';
+import type { Connection, Device, ResourcesResponse, WebLogin } from './myplex.types.js';
 import { PlexServer } from './server.js';
 /**
  * MyPlex account and profile information. This object represents the data found Account on
@@ -16,6 +16,19 @@ export declare class MyPlexAccount {
     timeout: number;
     server?: PlexServer;
     static key: string;
+    /**
+     * 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()`
+     * and present the returned uri to a user to go to, then await `webLoginCheck()`. If you pass in a
+     * `forwardUrl`, then send the user to the returned uri, and when a request comes in on the passed in
+     * url, then await `webLoginCheck()`.
+     */
+    static getWebLogin(forwardUrl?: string | null): Promise<WebLogin>;
+    /**
+     * Pass in the `webLogin` object obtained from `getWebLogin()` and this will poll Plex to see if
+     * the user agreed. It returns a connected `MyPlexAccount` or throws an error.
+     */
+    static webLoginCheck(webLogin: WebLogin, timeoutSeconds?: number): Promise<MyPlexAccount>;
     FRIENDINVITE: string;
     HOMEUSERCREATE: string;
     EXISTINGUSER: string;
@@ -136,7 +149,7 @@ export declare class MyPlexAccount {
  */
 export declare class MyPlexResource {
     readonly account: MyPlexAccount;
-    private baseUrl;
+    private readonly baseUrl;
     static key: string;
     TAG: string;
     /** Descriptive name of this resource */

package/dist/src/myplex.js

@@ -1,4 +1,4 @@
-import { URLSearchParams } from 'url';
+import { setTimeout as sleep } from 'node:timers/promises';
 import { ofetch } from 'ofetch';
 import pAny from 'p-any';
 import { parseStringPromise } from 'xml2js';
@@ -14,6 +14,71 @@ import { PlexServer } from './server.js';
  */
 export class MyPlexAccount {
     static { this.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()`
+     * and present the returned uri to a user to go to, then await `webLoginCheck()`. If you pass in a
+     * `forwardUrl`, then send the user to the returned uri, and when a request comes in on the passed in
+     * url, then await `webLoginCheck()`.
+     */
+    static async getWebLogin(forwardUrl = null) {
+        const appName = BASE_HEADERS['X-Plex-Product'];
+        const clientIdentifier = BASE_HEADERS['X-Plex-Client-Identifier'];
+        const pin = await ofetch('https://plex.tv/api/v2/pins', {
+            method: 'post',
+            headers: {
+                Accept: 'application/json',
+            },
+            query: {
+                strong: 'true',
+                'X-Plex-Product': appName,
+                'X-Plex-Client-Identifier': clientIdentifier,
+            },
+        });
+        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) : ''}`,
+        };
+    }
+    /**
+     * Pass in the `webLogin` object obtained from `getWebLogin()` and this will poll Plex to see if
+     * the user agreed. It returns a connected `MyPlexAccount` or throws an error.
+     */
+    static async webLoginCheck(webLogin, timeoutSeconds = 60) {
+        const recheckMs = 3000;
+        const clientIdentifier = BASE_HEADERS['X-Plex-Client-Identifier'];
+        const uri = `https://plex.tv/api/v2/pins/${webLogin.id}`;
+        const startTime = Date.now();
+        while (Date.now() < startTime + timeoutSeconds * 1000) {
+            try {
+                const tokenResponse = await ofetch(uri, {
+                    method: 'GET',
+                    headers: {
+                        Accept: 'application/json',
+                    },
+                    query: {
+                        code: webLogin.code,
+                        'X-Plex-Client-Identifier': clientIdentifier,
+                    },
+                    timeout: recheckMs,
+                    retry: 5,
+                    retryDelay: recheckMs,
+                });
+                if (tokenResponse.authToken) {
+                    const myPlexAccount = new MyPlexAccount(null, '', '', tokenResponse.authToken);
+                    return await myPlexAccount.connect();
+                }
+                await sleep(recheckMs);
+            }
+            catch (err) {
+                if (err.message.includes('aborted')) {
+                    continue;
+                }
+                throw err;
+            }
+        }
+        throw new Error('Failed to authenticate before timeout');
+    }
     /**
      *
      * @param username Your MyPlex username

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

@@ -130,3 +130,8 @@ export interface Device {
         };
     }>;
 }
+export interface WebLogin {
+    id: number;
+    code: string;
+    uri: string;
+}

package/dist/src/playlist.js

@@ -99,10 +99,8 @@ export class Playlist extends Playable {
             throw new BadRequest('Cannot remove items to a smart playlist.');
         }
         for (const item of items) {
-            // eslint-disable-next-line no-await-in-loop
             const playlistItemId = await this._getPlaylistItemID(item);
             const key = `${this.key}/items/${playlistItemId}`;
-            // eslint-disable-next-line no-await-in-loop
             await this.server.query(key, 'delete');
         }
     }

package/dist/src/server.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { URL, URLSearchParams } from 'url';
 import { PlexClient } from './client.js';
 import { Hub, Library } from './library.js';
@@ -172,7 +171,10 @@ export declare class PlexServer {
      * @param method
      * @param headers
      */
-    query<T = any>(path: string, method?: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete', headers?: any, username?: string, password?: string): Promise<T>;
+    query<T = any>(path: string, method?: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete', options?: {
+        headers?: Record<string, string>;
+        body?: Uint8Array;
+    }, username?: string, password?: string): Promise<T>;
     /**
      * Returns a list of media items from watched history. If there are many results, they will
      * be fetched from the server in batches of X_PLEX_CONTAINER_SIZE amounts. If you're only

package/dist/src/server.js

@@ -99,7 +99,7 @@ export class PlexServer {
      * @param method
      * @param headers
      */
-    async query(path, method = 'get', headers, username, password) {
+    async query(path, method = 'get', options = {}, username, password) {
         const requestHeaders = this._headers();
         if (username && password) {
             const credentials = Buffer.from(`${username}:${password}`).toString('base64');
@@ -113,6 +113,7 @@ export class PlexServer {
             method,
             headers: requestHeaders,
             timeout: this.timeout ?? TIMEOUT,
+            body: options.body,
             retry: 0,
             responseType: 'json',
         });
@@ -155,7 +156,6 @@ export class PlexServer {
             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();
-            // eslint-disable-next-line no-await-in-loop
             raw = await this.query(key);
             results = results.concat(raw.MediaContainer.Metadata);
         }
@@ -184,7 +184,6 @@ export class PlexServer {
      * you're likley to recieve an authentication error calling this.
      */
     myPlexAccount() {
-        // eslint-disable-next-line logical-assignment-operators
         if (!this._myPlexAccount) {
             this._myPlexAccount = new MyPlexAccount(this.baseurl, undefined, undefined, this.token, this.timeout, this);
         }
@@ -204,7 +203,6 @@ export class PlexServer {
         }
         for (const server of response.MediaContainer.Server) {
             let { port } = server;
-            // eslint-disable-next-line logical-assignment-operators
             if (!port) {
                 // TODO: print warning about doing weird port stuff
                 port = Number(ports?.[server.machineIdentifier]);

package/dist/src/settings.js

@@ -55,7 +55,6 @@ export class Settings extends PlexObject {
     }
     _loadData(data) {
         this._data = data;
-        // eslint-disable-next-line logical-assignment-operators
         this._settings = this._settings ?? {};
         for (const elem of data) {
             const id = lowerFirst(elem.id);

package/dist/src/video.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="node" resolution-mode="require"/>
 import { URL } from 'url';
 import { Playable } from './base/playable.js';
 import { ExtrasData, FullShowData, MovieData, ShowData } from './library.types.js';
-import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, Producer, Rating, Role, Similar, Writer } from './media.js';
+import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, Poster, Producer, Rating, Role, Similar, Writer } from './media.js';
 import { ChapterSource, EpisodeMetadata, FullMovieResponse } from './video.types.js';
 export type VideoType = Movie | Show;
 declare abstract class Video extends Playable {
@@ -52,6 +51,19 @@ declare abstract class Video extends Playable {
     markUnwatched(): Promise<void>;
     rate(rate: number): Promise<void>;
     extras(): Promise<Extra[]>;
+    /**
+     * Returns list of available Poster objects.
+     */
+    posters(): Promise<Poster[]>;
+    /**
+     * Set the poster for a Plex object.
+     * @param poster The poster object to select.
+     */
+    setPoster(poster: Poster): Promise<this>;
+    /**
+     * I haven't tested this yet. It may not work.
+     */
+    uploadPoster(url?: string, file?: Uint8Array): Promise<void>;
     protected _loadData(data: MovieData | ShowData | EpisodeMetadata): void;
 }
 /**

package/dist/src/video.js

@@ -1,6 +1,6 @@
 import { Playable } from './base/playable.js';
 import { fetchItem, fetchItems, findItems } from './baseFunctionality.js';
-import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, Producer, Rating, Role, Similar, Writer, } from './media.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);
@@ -53,6 +53,35 @@ class Video extends Playable {
         const data = await this.server.query(this._detailsKey);
         return findItems(data.MediaContainer.Metadata[0].Extras?.Metadata, undefined, Extra, this.server, this);
     }
+    /**
+     * Returns list of available Poster objects.
+     */
+    async posters() {
+        return fetchItems(this.server, `/library/metadata/${this.ratingKey}/posters`, undefined, Poster);
+    }
+    /**
+     * Set the poster for a Plex object.
+     * @param poster The poster object to select.
+     */
+    async setPoster(poster) {
+        await poster.select();
+        return this;
+    }
+    /**
+     * I haven't tested this yet. It may not work.
+     */
+    async uploadPoster(url, file) {
+        if (url) {
+            const key = `/library/metadata/${this.ratingKey}/posters?url=${encodeURIComponent(url)}`;
+            await this.server.query(key, 'post');
+        }
+        else if (file) {
+            const key = `/library/metadata/${this.ratingKey}/posters`;
+            await this.server.query(key, 'post', {
+                body: file,
+            });
+        }
+    }
     _loadData(data) {
         this.key = data.key;
         this.ratingKey = data.ratingKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/plex",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "plex api client in typescript",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "publishConfig": {
@@ -20,12 +20,12 @@
     "typescript"
   ],
   "scripts": {
-    "lint": "npm run lint:biome && npm run lint:eslint",
+    "lint": "pnpm run '/^(lint:biome|lint:eslint)$/'",
     "lint:biome": "biome check .",
-    "lint:eslint": "eslint --ext .ts,.tsx .",
-    "lint:fix": "npm run lint:biome:fix && npm run lint:eslint:fix",
-    "lint:eslint:fix": "eslint --ext .ts,.tsx . --fix",
-    "lint:biome:fix": "biome check . --apply",
+    "lint:eslint": "eslint .",
+    "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
+    "lint:eslint:fix": "eslint . --fix",
+    "lint:biome:fix": "biome check . --write",
     "prepare": "npm run build",
     "build": "tsc",
     "build:docs": "typedoc",
@@ -40,34 +40,29 @@
     "@ctrl/mac-address": "^3.0.3",
     "ofetch": "^1.3.4",
     "p-any": "^4.0.0",
-    "type-fest": "^4.18.1",
-    "ws": "^8.17.0",
+    "type-fest": "^4.24.0",
+    "ws": "^8.18.0",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.7.2",
-    "@ctrl/eslint-config-biome": "2.6.7",
-    "@sindresorhus/tsconfig": "5.0.0",
-    "@types/lodash": "4.17.1",
-    "@types/micromatch": "4.0.7",
-    "@types/node": "20.12.8",
-    "@types/ws": "8.5.10",
+    "@biomejs/biome": "1.8.3",
+    "@ctrl/eslint-config-biome": "4.1.3",
+    "@sindresorhus/tsconfig": "6.0.0",
+    "@types/node": "22.3.0",
+    "@types/ws": "8.5.12",
     "@types/xml2js": "0.4.14",
-    "@types/yargs": "17.0.32",
-    "@vitest/coverage-v8": "1.6.0",
-    "delay": "6.0.0",
-    "eslint": "8.57.0",
-    "execa": "8.0.1",
-    "glob": "10.3.12",
-    "globby": "14.0.1",
-    "lodash": "4.17.21",
+    "@types/yargs": "17.0.33",
+    "@vitest/coverage-v8": "2.0.5",
+    "eslint": "9.9.0",
+    "execa": "9.3.1",
+    "globby": "14.0.2",
     "make-dir": "5.0.0",
     "ora": "8.0.1",
     "p-retry": "6.2.0",
     "ts-node": "10.9.2",
-    "typedoc": "0.25.13",
-    "typescript": "5.4.5",
-    "vitest": "1.6.0",
+    "typedoc": "0.26.5",
+    "typescript": "5.5.4",
+    "vitest": "2.0.5",
     "yargs": "17.7.2"
   },
   "release": {