@ctrl/plex 2.1.0 → 3.1.0

package/README.md

@@ -98,3 +98,41 @@ Post testing, remove plex server from account. Warning this is destructive. Do n
 ```sh
 npm run test-cleanup
 ```
+
+
+### Running tests locally (mostly for myself)
+
+get a claim token from https://www.plex.tv/claim/
+export PLEX_CLAIM_TOKEN=claim-token
+
+```
+docker run -d \
+  --name=plex \
+  --net=host \
+  -h orbstack \
+  -p 32400:32400/tcp \
+  -p 32400:32400 \
+  -p 1900:1900/udp \
+  -p 5353:5353/udp \
+  -p 8324:8324 \
+  -p 32410:32410/udp \
+  -p 32412:32412/udp \
+  -p 32413:32413/udp \
+  -p 32414:32414/udp \
+  -p 32469:32469 \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e TZ=Etc/UTC \
+  -e VERSION=docker \
+  -e PLEX_CLAIM=$PLEX_CLAIM_TOKEN \
+  -v /Users/scooper/gh/plex/plex/media/db:/config \
+  -v /Users/scooper/gh/plex/plex/media/transcode:/transcode \
+  -v /Users/scooper/gh/plex/plex/media:/data \
+  --restart unless-stopped \
+  lscr.io/linuxserver/plex:latest
+```
+
+bootstrap media
+```
+NODE_OPTIONS="--loader ts-node/esm" node scripts/bootstraptest.ts --no-docker --server-name=orbstack`
+```

package/dist/src/client.d.ts

@@ -67,6 +67,7 @@ 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
@@ -74,7 +75,7 @@ export declare class PlexClient {
      * populated from a PlexServer.
      * @param timeout
      */
-    connect(timeout?: number): Promise<void>;
+    connect(): Promise<void>;
     /**
      * @alias PlexClient.connect
      */
@@ -89,7 +90,7 @@ export declare class PlexClient {
      * @param headers
      * @param timeout
      */
-    query<T>(path: string, method?: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete', headers?: Record<string, string>, timeout?: number): Promise<T>;
+    query<T>(path: string, method?: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete', headers?: Record<string, string>): Promise<T>;
     /**
      * Build a URL string with proper token argument. Token will be appended to the URL
      * if either includeToken is True or TODO: CONFIG.log.show_secrets is 'true'.

package/dist/src/client.js

@@ -1,5 +1,5 @@
 import { URL, URLSearchParams } from 'url';
-import got from 'got';
+import { ofetch } from 'ofetch';
 import { BASE_HEADERS, TIMEOUT } from './config.js';
 /**
  * Main class for interacting with a Plex client. This class can connect
@@ -53,6 +53,7 @@ export class PlexClient {
         }
         this._baseurl = options.baseurl ?? 'http://localhost:32400';
         this._token = options.token ?? null;
+        this.timeout = options.timeout ?? TIMEOUT;
     }
     /**
      * Alias of reload as any subsequent requests to this client will be
@@ -60,8 +61,8 @@ export class PlexClient {
      * populated from a PlexServer.
      * @param timeout
      */
-    async connect(timeout) {
-        const data = await this.query(this.key, undefined, undefined, timeout);
+    async connect() {
+        const data = await this.query(this.key);
         this._loadData(data.MediaContainer.Player);
     }
     /**
@@ -80,15 +81,15 @@ export class PlexClient {
      * @param headers
      * @param timeout
      */
-    async query(path, method = 'get', headers, timeout) {
+    async query(path, method = 'get', headers) {
         const headersObj = this.headers(headers);
-        const response = await got({
+        const response = await ofetch(this.url(path).toString(), {
             method,
-            url: this.url(path),
-            timeout: { request: timeout ?? TIMEOUT },
+            timeout: this.timeout ?? TIMEOUT,
             headers: headersObj,
-            retry: { limit: 0 },
-        }).json();
+            responseType: 'json',
+            retry: 0,
+        });
         return response;
     }
     /**
@@ -128,6 +129,7 @@ export class PlexClient {
         const headersObj = {
             ...BASE_HEADERS,
             ...headers,
+            accept: 'application/json',
         };
         if (this._token) {
             headersObj['X-Plex-Token'] = this._token;

package/dist/src/config.d.ts

@@ -1,5 +1,8 @@
 export declare const PROJECT = "PlexAPI";
 export declare const VERSION = "3.3.0";
+/**
+ * Default timeout for requests in milliseconds.
+ */
 export declare const TIMEOUT = 30000;
 export declare const X_PLEX_CONTAINER_SIZE = 100;
 export declare const X_PLEX_ENABLE_FAST_CONNECT: false;

package/dist/src/config.js

@@ -7,7 +7,10 @@ import { getMAC, parseMAC } from '@ctrl/mac-address';
 // PlexAPI Settings
 export const PROJECT = 'PlexAPI';
 export const VERSION = '3.3.0';
-export const TIMEOUT = 30000;
+/**
+ * Default timeout for requests in milliseconds.
+ */
+export const TIMEOUT = 30_000;
 export const X_PLEX_CONTAINER_SIZE = 100;
 export const X_PLEX_ENABLE_FAST_CONNECT = false;
 // Plex Header Configuation

package/dist/src/library.d.ts

@@ -260,7 +260,7 @@ export declare abstract class LibrarySection<SectionVideoType = VideoType> exten
     readonly VIDEO_TYPE: Class<SectionVideoType>;
     _filterTypes?: FilteringType[];
     _fieldTypes?: FilteringFieldType[];
-    all(sort?: string): Promise<any[]>;
+    all(sort?: string): Promise<SectionVideoType[]>;
     agents(): Promise<Agent[]>;
     /**
      * @param title Title of the item to return.

package/dist/src/library.js

@@ -283,7 +283,7 @@ export class LibrarySection extends PlexObject {
             sortStr = `?sort=${sort}`;
         }
         const key = `/library/sections/${this.key}/all${sortStr}`;
-        const items = await fetchItems(this.server, key);
+        const items = await fetchItems(this.server, key, undefined, this.VIDEO_TYPE, this);
         return items;
     }
     async agents() {

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

@@ -110,6 +110,7 @@ export interface MovieData {
     Extras?: ExtrasData[];
     Guid?: Guid[];
     Marker?: MarkerData[];
+    Rating?: MediaRating[];
 }
 export interface MediaTag {
     tag: string;
@@ -246,4 +247,15 @@ interface ExtrasStream {
     selected?: boolean;
     channels?: number;
 }
+interface MediaRating {
+    image: string;
+    /**
+     * ex 8.3
+     */
+    value: number;
+    /**
+     * ex 'audience'
+     */
+    type: string;
+}
 export {};

package/dist/src/media.d.ts

@@ -179,4 +179,25 @@ declare class GuidTag extends PlexObject {
 export declare class Guid extends GuidTag {
     static TAG: "Guid";
 }
+/**
+ * Represents a single Rating media tag.
+ */
+export declare class Rating extends PlexObject {
+    static TAG: "Rating";
+    /**
+     * The uri for the rating image
+     * (e.g. ``imdb://image.rating``, ``rottentomatoes://image.rating.ripe``,
+     * ``rottentomatoes://image.rating.upright``, ``themoviedb://image.rating``).
+     */
+    image: string;
+    /**
+     * The type of rating (e.g. audience or critic).
+     */
+    type: 'audience' | 'critic';
+    /**
+     * The rating value.
+     */
+    value: number;
+    protected _loadData(data: any): void;
+}
 export {};

package/dist/src/media.js

@@ -189,3 +189,14 @@ class GuidTag extends PlexObject {
 export class Guid extends GuidTag {
     static { this.TAG = 'Guid'; }
 }
+/**
+ * Represents a single Rating media tag.
+ */
+export class Rating extends PlexObject {
+    static { this.TAG = 'Rating'; }
+    _loadData(data) {
+        this.image = data.image;
+        this.type = data.type;
+        this.value = data.value;
+    }
+}

package/dist/src/myplex.d.ts

@@ -9,12 +9,12 @@ import { PlexServer } from './server.js';
  * and return this object.
  */
 export declare class MyPlexAccount {
-    private readonly baseUrl;
+    baseUrl: string | null;
     username?: string;
-    private readonly password?;
+    password?: string;
     token?: string;
-    private readonly timeout;
-    private readonly server?;
+    timeout: number;
+    server?: PlexServer;
     static key: string;
     FRIENDINVITE: string;
     HOMEUSERCREATE: string;
@@ -115,7 +115,7 @@ export declare class MyPlexAccount {
      * @param headers
      * @param timeout
      */
-    query<T = any>(url: string, method?: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete', headers?: any, timeout?: number, username?: string, password?: string): Promise<T>;
+    query<T = any>(url: string, method?: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete', headers?: any, username?: string, password?: string): Promise<T>;
     /**
      * Returns a str, a new "claim-token", which you can use to register your new Plex Server instance to your account.
      * @link https://hub.docker.com/r/plexinc/pms-docker/
@@ -136,7 +136,7 @@ export declare class MyPlexAccount {
  */
 export declare class MyPlexResource {
     readonly account: MyPlexAccount;
-    private readonly baseUrl;
+    private baseUrl;
     static key: string;
     TAG: string;
     /** Descriptive name of this resource */

package/dist/src/myplex.js

@@ -1,5 +1,5 @@
-import { URL, URLSearchParams } from 'url';
-import got from 'got';
+import { URLSearchParams } from 'url';
+import { ofetch } from 'ofetch';
 import pAny from 'p-any';
 import { parseStringPromise } from 'xml2js';
 import { PlexObject } from './base/plexObject.js';
@@ -64,8 +64,7 @@ export class MyPlexAccount {
      */
     async connect() {
         if (!this.token) {
-            // log('Logging in with username', { username: this.username });
-            const data = await this._signin(this.username, this.password, this.timeout);
+            const data = await this._signin(this.username, this.password);
             this._loadData(data);
             return this;
         }
@@ -118,27 +117,28 @@ export class MyPlexAccount {
      * @param headers
      * @param timeout
      */
-    async query(url, method = 'get', headers, timeout, username, password) {
+    async query(url, method = 'get', headers, username, password) {
         const requestHeaders = this._headers();
         if (username && password) {
             const credentials = Buffer.from(`${username}:${password}`).toString('base64');
             requestHeaders.Authorization = `Basic ${credentials}`;
         }
-        const promise = got({
+        if (!url.includes('xml')) {
+            requestHeaders.accept = 'application/json';
+        }
+        const body = await ofetch(url, {
             method,
-            url: new URL(url),
             headers: requestHeaders,
-            timeout: { request: timeout ?? TIMEOUT },
-            ...(username ? { username } : {}),
-            ...(password ? { password } : {}),
-            retry: { limit: 0 },
+            timeout: this.timeout ?? TIMEOUT,
+            retry: 0,
+            parseResponse: res => res,
+            // Can't seem to pass responseType
         });
         if (url.includes('xml')) {
-            const res = await promise;
-            const xml = await parseStringPromise(res.body);
+            const xml = await parseStringPromise(body);
             return xml;
         }
-        const res = await promise.json();
+        const res = JSON.parse(body);
         return res;
     }
     /**
@@ -148,7 +148,7 @@ export class MyPlexAccount {
      */
     async claimToken() {
         const url = 'https://plex.tv/api/claim/token.json';
-        const response = await this.query(url, 'get', undefined, TIMEOUT);
+        const response = await this.query(url, 'get', undefined);
         return response.token;
     }
     /**
@@ -160,12 +160,11 @@ export class MyPlexAccount {
             ...BASE_HEADERS,
         });
         const url = `${this.baseUrl}/myplex/claim?${params.toString()}`;
-        return got({
-            method: 'POST',
-            url,
-            timeout: { request: TIMEOUT },
+        return ofetch(url, {
+            method: 'post',
+            timeout: TIMEOUT,
             headers: this._headers(),
-            retry: { limit: 0 },
+            retry: 0,
         });
     }
     _headers() {
@@ -178,8 +177,8 @@ export class MyPlexAccount {
         }
         return headers;
     }
-    async _signin(username, password, timeout) {
-        const data = await this.query(this.SIGNIN, 'post', undefined, timeout, username, password);
+    async _signin(username, password) {
+        const data = await this.query(this.SIGNIN, 'post', undefined, username, password);
         return data.user;
     }
     _loadData(user) {
@@ -265,7 +264,7 @@ export class MyPlexResource {
     /** Remove this device from your account */
     async delete() {
         const key = `https://plex.tv/api/servers/${this.clientIdentifier}?X-Plex-Client-Identifier=${BASE_HEADERS['X-Plex-Client-Identifier']}&X-Plex-Token=${this.accessToken}`;
-        await got.delete(key, { retry: { limit: 0 } });
+        await ofetch(key, { method: 'delete', retry: 0 });
     }
     _loadData(data) {
         this.name = data.name;

package/dist/src/server.d.ts

@@ -15,9 +15,13 @@ import { Settings } from './settings.js';
  * can also create an PlexServer instance from :class:`~plexapi.myplex.MyPlexAccount`.
  */
 export declare class PlexServer {
-    readonly baseurl: string;
-    readonly token: string;
-    readonly timeout?: number;
+    baseurl: string;
+    token: string;
+    /**
+     * Default request timeout in milliseconds.
+     * @default 30000
+     */
+    timeout: number;
     key: string;
     /** True if server allows camera upload */
     allowCameraUpload: boolean;
@@ -131,7 +135,12 @@ export declare class PlexServer {
     _library?: Library;
     _settings?: Settings;
     private _myPlexAccount?;
-    constructor(baseurl: string, token: string, timeout?: number);
+    constructor(baseurl: string, token: string, 
+    /**
+     * Default request timeout in milliseconds.
+     * @default 30000
+     */
+    timeout?: number);
     agents(mediaType?: number | string): Promise<Agent[]>;
     connect(): Promise<void>;
     /**
@@ -162,9 +171,8 @@ export declare class PlexServer {
      * @param path
      * @param method
      * @param headers
-     * @param timeout
      */
-    query<T = any>(path: string, method?: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete', headers?: any, timeout?: number, username?: string, password?: string): Promise<T>;
+    query<T = any>(path: string, method?: 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete', headers?: any, 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

@@ -1,5 +1,5 @@
 import { URL, URLSearchParams } from 'url';
-import got from 'got';
+import { ofetch } from 'ofetch';
 import { fetchItem, fetchItems } from './baseFunctionality.js';
 import { PlexClient } from './client.js';
 import { BASE_HEADERS, TIMEOUT, X_PLEX_CONTAINER_SIZE } from './config.js';
@@ -16,7 +16,12 @@ import { Settings } from './settings.js';
  * can also create an PlexServer instance from :class:`~plexapi.myplex.MyPlexAccount`.
  */
 export class PlexServer {
-    constructor(baseurl, token, timeout) {
+    constructor(baseurl, token, 
+    /**
+     * Default request timeout in milliseconds.
+     * @default 30000
+     */
+    timeout = TIMEOUT) {
         this.baseurl = baseurl;
         this.token = token;
         this.timeout = timeout;
@@ -30,7 +35,7 @@ export class PlexServer {
         return fetchItems(this, key, undefined, Agent, this);
     }
     async connect() {
-        const data = await this.query(this.key, undefined, undefined, this.timeout);
+        const data = await this.query(this.key);
         this._loadData(data.MediaContainer);
         // Attempt to prevent token from being logged accidentally
         if (this.token) {
@@ -93,24 +98,24 @@ export class PlexServer {
      * @param path
      * @param method
      * @param headers
-     * @param timeout
      */
-    async query(path, method = 'get', headers, timeout, username, password) {
+    async query(path, method = 'get', headers, username, password) {
         const requestHeaders = this._headers();
         if (username && password) {
             const credentials = Buffer.from(`${username}:${password}`).toString('base64');
             requestHeaders.Authorization = `Basic ${credentials}`;
         }
         const url = this.url(path);
-        const response = await got({
+        if (!url.toString().includes('xml')) {
+            requestHeaders.accept = 'application/json';
+        }
+        const response = await ofetch(url.toString(), {
             method,
-            url,
             headers: requestHeaders,
-            timeout: { request: timeout ?? TIMEOUT },
-            ...(username ? { username } : {}),
-            ...(password ? { password } : {}),
-            retry: { limit: 0 },
-        }).json();
+            timeout: this.timeout ?? TIMEOUT,
+            retry: 0,
+            responseType: 'json',
+        });
         return response;
     }
     /**

package/dist/src/video.d.ts

@@ -2,7 +2,7 @@
 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, Role, Similar, Writer } from './media.js';
+import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, 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 {
@@ -95,6 +95,7 @@ export declare class Movie extends Video {
     media: Media[];
     guids: Guid[];
     markers: Marker[];
+    ratings?: Rating[];
     get actors(): Role[];
     locations(): Promise<string[]>;
     /**

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, Role, Similar, Writer, } from './media.js';
+import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, Producer, Rating, Role, Similar, Writer, } from './media.js';
 class Video extends Playable {
     constructor() {
         super(...arguments);
@@ -143,6 +143,7 @@ export class Movie extends Video {
         this.media = data.Media?.map(d => new Media(this.server, d, undefined, this)) ?? [];
         this.guids = data.Guid?.map(d => new Guid(this.server, d, undefined, this)) ?? [];
         this.markers = data.Marker?.map(d => new Marker(this.server, d, undefined, this)) ?? [];
+        this.ratings = data.Rating?.map(d => new Rating(this.server, d, undefined, this)) ?? [];
     }
     _loadFullData(data) {
         const metadata = data.Metadata[0];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/plex",
-  "version": "2.1.0",
+  "version": "3.1.0",
   "description": "plex api client in typescript",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "publishConfig": {
@@ -20,10 +20,10 @@
     "typescript"
   ],
   "scripts": {
-    "lint": "pnpm run '/^(lint:biome|lint:eslint)$/'",
+    "lint": "npm run lint:biome && npm run lint:eslint",
     "lint:biome": "biome check .",
     "lint:eslint": "eslint --ext .ts,.tsx .",
-    "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
+    "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",
     "prepare": "npm run build",
@@ -33,42 +33,41 @@
     "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml",
     "bootstraptest": "node --loader ts-node/esm scripts/bootstraptest.ts",
     "teardowntest": "node --loader ts-node/esm scripts/teardowntest.ts",
-    "claim-server": "node --loader ts-node/esm scripts/claim-server.ts",
     "add-media": "node --loader ts-node/esm scripts/add-media.ts",
     "test-cleanup": "node --loader ts-node/esm scripts/test-cleanup.ts"
   },
   "dependencies": {
     "@ctrl/mac-address": "^3.0.3",
-    "got": "^13.0.0",
+    "ofetch": "^1.3.4",
     "p-any": "^4.0.0",
-    "type-fest": "^4.16.0",
-    "ws": "^8.16.0",
+    "type-fest": "^4.18.1",
+    "ws": "^8.17.0",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.7.1",
-    "@ctrl/eslint-config-biome": "2.6.5",
+    "@biomejs/biome": "1.7.2",
+    "@ctrl/eslint-config-biome": "2.6.7",
     "@sindresorhus/tsconfig": "5.0.0",
-    "@types/lodash": "4.17.0",
+    "@types/lodash": "4.17.1",
     "@types/micromatch": "4.0.7",
-    "@types/node": "20.12.7",
+    "@types/node": "20.12.8",
     "@types/ws": "8.5.10",
     "@types/xml2js": "0.4.14",
     "@types/yargs": "17.0.32",
-    "@vitest/coverage-v8": "1.5.0",
+    "@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",
-    "make-dir": "4.0.0",
+    "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.5.0",
+    "vitest": "1.6.0",
     "yargs": "17.7.2"
   },
   "release": {