@ctrl/plex 1.5.2 → 2.0.0

package/dist/{server.d.ts → src/server.d.ts}

@@ -1,11 +1,12 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { URL, URLSearchParams } from 'url';
-import { HistoryMetadatum } from './server.types';
-import { Library, Hub } from './library';
-import { Optimized } from './media';
-import { Agent, SEARCHTYPES } from './search';
-import { PlexClient } from './client';
-import { MyPlexAccount } from './myplex';
+import { PlexClient } from './client.js';
+import { Hub, Library } from './library.js';
+import { Optimized } from './media.js';
+import { MyPlexAccount } from './myplex.js';
+import { Agent, SEARCHTYPES } from './search.js';
+import { HistoryMetadatum } from './server.types.js';
+import { Settings } from './settings.js';
 /**
  * This is the main entry point to interacting with a Plex server. It allows you to
  * list connected clients, browse your library sections and perform actions such as
@@ -16,7 +17,7 @@ import { MyPlexAccount } from './myplex';
 export declare class PlexServer {
     readonly baseurl: string;
     readonly token: string;
-    readonly timeout?: number | undefined;
+    readonly timeout?: number;
     key: string;
     /** True if server allows camera upload */
     allowCameraUpload: boolean;
@@ -51,7 +52,7 @@ export declare class PlexServer {
      */
     hubSearch: boolean;
     /** Unique ID for this server (looks like an md5) */
-    machineIdentifier: string;
+    machineIdentifier?: string;
     /**
      * True if `multiusers <https!://support.plex.tv/hc/en-us/articles/200250367-Multi-User-Support>`_ are enabled.
      */
@@ -128,8 +129,9 @@ export declare class PlexServer {
     /** Unknown */
     pushNotifications: boolean;
     _library?: Library;
+    _settings?: Settings;
     private _myPlexAccount?;
-    constructor(baseurl: string, token: string, timeout?: number | undefined);
+    constructor(baseurl: string, token: string, timeout?: number);
     agents(mediaType?: number | string): Promise<Agent[]>;
     connect(): Promise<void>;
     /**
@@ -175,6 +177,7 @@ export declare class PlexServer {
      * @param librarySectionId request history for a specific library section ID.
      */
     history(maxresults?: number, mindate?: Date, ratingKey?: number | string, accountId?: number | string, librarySectionId?: number | string): Promise<HistoryMetadatum[]>;
+    settings(): Promise<Settings>;
     /**
      * Returns a :class:`~plexapi.myplex.MyPlexAccount` object using the same
      * token to access this server. If you are not the owner of this PlexServer
@@ -189,6 +192,15 @@ export declare class PlexServer {
      * if either includeToken is True or TODO: CONFIG.log.show_secrets is 'true'.
      */
     url(key: string, includeToken?: boolean, params?: URLSearchParams): URL;
+    /**
+     * Build the Plex Web URL for the object.
+     * @param base The base URL before the fragment (``#!``).
+     *    Default is https://app.plex.tv/desktop.
+     * @param endpoint The Plex Web URL endpoint.
+     *    None for server, 'playlist' for playlists, 'details' for all other media types.
+     */
+    _buildWebURL(base?: string, endpoint?: string, params?: URLSearchParams): string;
+    _uriRoot(): string;
     private _headers;
     private _loadData;
     /**

package/dist/{server.js → src/server.js}

@@ -1,18 +1,13 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlexServer = void 0;
-const got_1 = __importDefault(require("got"));
-const url_1 = require("url");
-const config_1 = require("./config");
-const library_1 = require("./library");
-const baseFunctionality_1 = require("./baseFunctionality");
-const media_1 = require("./media");
-const search_1 = require("./search");
-const client_1 = require("./client");
-const myplex_1 = require("./myplex");
+import { URL, URLSearchParams } from 'url';
+import got from 'got';
+import { fetchItem, fetchItems } from './baseFunctionality.js';
+import { PlexClient } from './client.js';
+import { BASE_HEADERS, TIMEOUT, X_PLEX_CONTAINER_SIZE } from './config.js';
+import { Hub, Library } from './library.js';
+import { Optimized } from './media.js';
+import { MyPlexAccount } from './myplex.js';
+import { Agent, SEARCHTYPES } from './search.js';
+import { Settings } from './settings.js';
 /**
  * This is the main entry point to interacting with a Plex server. It allows you to
  * list connected clients, browse your library sections and perform actions such as
@@ -20,7 +15,7 @@ const myplex_1 = require("./myplex");
  * server, or simply want to access your server with your username and password, you
  * can also create an PlexServer instance from :class:`~plexapi.myplex.MyPlexAccount`.
  */
-class PlexServer {
+export class PlexServer {
     constructor(baseurl, token, timeout) {
         this.baseurl = baseurl;
         this.token = token;
@@ -32,7 +27,7 @@ class PlexServer {
         if (mediaType) {
             key += `?mediaType=${mediaType}`;
         }
-        return baseFunctionality_1.fetchItems(this, key, undefined, search_1.Agent, this);
+        return fetchItems(this, key, undefined, Agent, this);
     }
     async connect() {
         const data = await this.query(this.key, undefined, undefined, this.timeout);
@@ -53,13 +48,13 @@ class PlexServer {
             return this._library;
         }
         try {
-            const data = await this.query(library_1.Library.key);
-            this._library = new library_1.Library(this, data.MediaContainer);
+            const data = await this.query(Library.key);
+            this._library = new Library(this, data.MediaContainer);
         }
-        catch (_a) {
+        catch {
             // TODO: validate error type, also TODO figure out how this is used
             const data = await this.query('/library/sections/');
-            this._library = new library_1.Library(this, data.MediaContainer);
+            this._library = new Library(this, data.MediaContainer);
         }
         return this._library;
     }
@@ -81,13 +76,13 @@ class PlexServer {
     async search(query, mediatype, limit) {
         const params = { query };
         if (mediatype) {
-            params.section = search_1.SEARCHTYPES[mediatype].toString();
+            params.section = SEARCHTYPES[mediatype].toString();
         }
         if (limit) {
             params.limit = limit.toString();
         }
-        const key = '/hubs/search?' + new url_1.URLSearchParams(params).toString();
-        const hubs = await baseFunctionality_1.fetchItems(this, key, undefined, library_1.Hub, this);
+        const key = '/hubs/search?' + new URLSearchParams(params).toString();
+        const hubs = await fetchItems(this, key, undefined, Hub, this);
         return hubs;
     }
     /**
@@ -107,14 +102,14 @@ class PlexServer {
             requestHeaders.Authorization = `Basic ${credentials}`;
         }
         const url = this.url(path);
-        const response = await got_1.default({
+        const response = await got({
             method,
             url,
             headers: requestHeaders,
-            timeout: timeout !== null && timeout !== void 0 ? timeout : config_1.TIMEOUT,
-            username,
-            password,
-            retry: 0,
+            timeout: { request: timeout ?? TIMEOUT },
+            ...(username ? { username } : {}),
+            ...(password ? { password } : {}),
+            retry: { limit: 0 },
         }).json();
         return response;
     }
@@ -144,23 +139,30 @@ class PlexServer {
             args['viewedAt>'] = mindate.getTime().toString();
         }
         args['X-Plex-Container-Start'] = '0';
-        args['X-Plex-Container-Size'] = Math.min(config_1.X_PLEX_CONTAINER_SIZE, maxresults).toString();
+        args['X-Plex-Container-Size'] = Math.min(X_PLEX_CONTAINER_SIZE, maxresults).toString();
         let results = [];
-        let key = '/status/sessions/history/all?' + new url_1.URLSearchParams(args).toString();
+        let key = '/status/sessions/history/all?' + new URLSearchParams(args).toString();
         let raw = await this.query(key);
         const totalResults = raw.MediaContainer.totalSize;
         results = results.concat(raw.MediaContainer.Metadata);
         while (results.length <= totalResults &&
-            config_1.X_PLEX_CONTAINER_SIZE === raw.MediaContainer.size &&
+            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 url_1.URLSearchParams(args).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);
         }
         return results;
     }
+    async settings() {
+        if (!this._settings) {
+            const data = await this.query(Settings.key);
+            this._settings = new Settings(this, data.MediaContainer.Setting);
+        }
+        return this._settings;
+    }
     // TODO: not sure if this works
     // /**
     //  * Returns a list of all playlist objects saved on the server.
@@ -178,38 +180,37 @@ class PlexServer {
      */
     myPlexAccount() {
         if (!this._myPlexAccount) {
-            this._myPlexAccount = new myplex_1.MyPlexAccount(this.baseurl, undefined, undefined, this.token, this.timeout, this);
+            this._myPlexAccount = new MyPlexAccount(this.baseurl, undefined, undefined, this.token, this.timeout, this);
         }
         return this._myPlexAccount;
     }
     // Returns list of all :class:`~plexapi.client.PlexClient` objects connected to server.
     async clients() {
-        var _a, _b;
         const items = [];
         const response = await this.query('/clients');
-        if (((_a = response.MediaContainer) === null || _a === void 0 ? void 0 : _a.Server) === undefined) {
+        if (response.MediaContainer?.Server === undefined) {
             return [];
         }
         const shouldFetchPorts = response.MediaContainer.Server.some(server => server.port === null || server.port === undefined);
-        let ports;
+        let ports = {};
         if (shouldFetchPorts) {
             ports = await this._myPlexClientPorts();
         }
         for (const server of response.MediaContainer.Server) {
-            let port = server.port;
+            let { port } = server;
             if (!port) {
                 // TODO: print warning about doing weird port stuff
-                port = (_b = ports) === null || _b === void 0 ? void 0 : _b[server.machineIdentifier];
+                port = Number(ports?.[server.machineIdentifier]);
             }
             const baseurl = `http://${server.host}:${port}`;
-            items.push(new client_1.PlexClient({ baseurl, token: this.token, server: this, data: server }));
+            items.push(new PlexClient({ baseurl, token: this.token, server: this, data: server }));
         }
         return items;
     }
     /** Returns list of all :class:`~plexapi.media.Optimized` objects connected to server. */
     async optimizedItems() {
-        const backgroundProcessing = await baseFunctionality_1.fetchItem(this, '/playlists?type=42');
-        const items = await baseFunctionality_1.fetchItems(this, backgroundProcessing.key, undefined, media_1.Optimized, this);
+        const backgroundProcessing = await fetchItem(this, '/playlists?type=42');
+        const items = await fetchItems(this, backgroundProcessing.key, undefined, Optimized, this);
         return items;
     }
     /**
@@ -220,18 +221,34 @@ class PlexServer {
         if (!this.baseurl) {
             throw new Error('PlexClient object missing baseurl.');
         }
-        const url = new url_1.URL(key, this.baseurl);
+        const url = new URL(key, this.baseurl);
         if (this.token && includeToken) {
-            const searchParams = new url_1.URLSearchParams(params);
+            const searchParams = new URLSearchParams(params);
             searchParams.append('X-Plex-Token', this.token);
             url.search = searchParams.toString();
             return url;
         }
         return url;
     }
+    /**
+     * Build the Plex Web URL for the object.
+     * @param base The base URL before the fragment (``#!``).
+     *    Default is https://app.plex.tv/desktop.
+     * @param endpoint The Plex Web URL endpoint.
+     *    None for server, 'playlist' for playlists, 'details' for all other media types.
+     */
+    _buildWebURL(base = 'https://app.plex.tv/desktop/', endpoint, params) {
+        if (endpoint) {
+            return `${base}#!/server/${this.machineIdentifier}/${endpoint}?${params?.toString()}`;
+        }
+        return `${base}#!/media/${this.machineIdentifier}/com.plexapp.plugins.library?${params?.toString()}`;
+    }
+    _uriRoot() {
+        return `server://${this.machineIdentifier}/com.plexapp.plugins.library`;
+    }
     _headers() {
         const headers = {
-            ...config_1.BASE_HEADERS,
+            ...BASE_HEADERS,
             'Content-type': 'application/json',
         };
         if (this.token) {
@@ -292,16 +309,14 @@ class PlexServer {
      * See python plex issue #126: Make PlexServer.clients() more user friendly.
      */
     async _myPlexClientPorts() {
-        var _a;
-        let ports = {};
+        const ports = {};
         const account = this.myPlexAccount();
         const devices = await account.devices();
         for (const device of devices) {
-            if ((_a = device.connections) === null || _a === void 0 ? void 0 : _a.length) {
-                ports[device.clientIdentifier] = new url_1.URL('http://172.17.0.2:32400').port;
+            if (device.connections?.length) {
+                ports[device.clientIdentifier] = new URL('http://172.17.0.2:32400').port;
             }
         }
         return ports;
     }
 }
-exports.PlexServer = PlexServer;

package/dist/src/server.types.js

@@ -0,0 +1 @@
+export {};

package/dist/src/settings.d.ts

@@ -0,0 +1,79 @@
+import { PlexObject } from './base/plexObject.js';
+export interface SettingResponse {
+    id: string;
+    label: string;
+    summary: string;
+    type: Type;
+    default: boolean | number | string;
+    value: boolean | number | string;
+    hidden: boolean;
+    advanced: boolean;
+    group: SettingsGroup;
+}
+declare enum SettingsGroup {
+    Butler = "butler",
+    Channels = "channels",
+    Dlna = "dlna",
+    Empty = "",
+    Extras = "extras",
+    General = "general",
+    Library = "library",
+    Network = "network",
+    Transcoder = "transcoder"
+}
+declare enum Type {
+    Bool = "bool",
+    Double = "double",
+    Int = "int",
+    Text = "text"
+}
+export declare class Settings extends PlexObject {
+    static key: string;
+    _settings: Record<string, Setting>;
+    _data: SettingResponse[];
+    all(): Setting[];
+    get(id: string): Setting;
+    /**
+     * Save any outstanding settnig changes to the PlexServer. This
+     * performs a full reload() of Settings after complete.
+     */
+    save(): Promise<void>;
+    _loadData(data: SettingResponse[]): void;
+}
+/**
+ * Represents a single Plex setting
+ */
+export declare class Setting extends PlexObject {
+    /** Setting id (or name). */
+    id: string;
+    /** Short description of what this setting is. */
+    label: string;
+    /** Long description of what this setting is. */
+    summary: string;
+    /** Setting type (text, int, double, bool). */
+    type: string;
+    /** Default value for this setting. */
+    default: string | boolean | number;
+    /** Current value for this setting. */
+    value: string | boolean | number;
+    /** True if this is a hidden setting. */
+    hidden: boolean;
+    /** True if this is an advanced setting. */
+    advanced: boolean;
+    /** Group name this setting is categorized as. */
+    group: string;
+    /** List or dictionary of valis values for this setting. */
+    enumValues: any[] | any;
+    _setValue: string | boolean | number | 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: string | boolean | number): void;
+    _loadData(data: SettingResponse): void;
+}
+export declare class Preferences extends Setting {
+    static TAG: "Preferences";
+    FILTER: "preferences";
+}
+export {};

package/dist/src/settings.js

@@ -0,0 +1,160 @@
+import { URLSearchParams } from 'url';
+import { PlexObject } from './base/plexObject.js';
+import { NotFound } from './exceptions.js';
+import { lowerFirst } from './util.js';
+var SettingsGroup;
+(function (SettingsGroup) {
+    SettingsGroup["Butler"] = "butler";
+    SettingsGroup["Channels"] = "channels";
+    SettingsGroup["Dlna"] = "dlna";
+    SettingsGroup["Empty"] = "";
+    SettingsGroup["Extras"] = "extras";
+    SettingsGroup["General"] = "general";
+    SettingsGroup["Library"] = "library";
+    SettingsGroup["Network"] = "network";
+    SettingsGroup["Transcoder"] = "transcoder";
+})(SettingsGroup || (SettingsGroup = {}));
+var Type;
+(function (Type) {
+    Type["Bool"] = "bool";
+    Type["Double"] = "double";
+    Type["Int"] = "int";
+    Type["Text"] = "text";
+})(Type || (Type = {}));
+export class Settings extends PlexObject {
+    constructor() {
+        super(...arguments);
+        this._data = [];
+    }
+    static { this.key = '/:/prefs'; }
+    all() {
+        return Object.entries(this._settings)
+            .sort((a, b) => a[0].localeCompare(b[0]))
+            .map(x => x[1]);
+    }
+    get(id) {
+        const lowerId = lowerFirst(id);
+        if (this._settings[lowerId]) {
+            return this._settings[lowerId];
+        }
+        throw new NotFound(`Invalid setting id: ${id}`);
+    }
+    /**
+     * Save any outstanding settnig changes to the PlexServer. This
+     * performs a full reload() of Settings after complete.
+     */
+    async save() {
+        const params = new URLSearchParams();
+        for (const setting of this.all()) {
+            if (setting._setValue !== null) {
+                params.append('setting.id', JSON.stringify(setting._setValue));
+            }
+        }
+        const url = `${this.key}?${params.toString()}`;
+        await this.server.query(url, 'put');
+    }
+    _loadData(data) {
+        this._data = data;
+        this._settings = this._settings ?? {};
+        for (const elem of data) {
+            const id = lowerFirst(elem.id);
+            if (this._settings[id]) {
+                this._settings[id]._loadData(elem);
+                continue;
+            }
+            this._settings[id] = new Setting(this.server, elem, this.initpath);
+        }
+    }
+}
+/**
+ * Represents a single Plex setting
+ */
+export class Setting extends PlexObject {
+    constructor() {
+        super(...arguments);
+        this._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');
+        }
+        this._setValue = value;
+    }
+    _loadData(data) {
+        // this._setValue = None
+        this.id = data.id;
+        this.label = data.label;
+        this.summary = data.summary;
+        this.type = data.type;
+        this.default = data.default;
+        this.value = data.value;
+        this.hidden = data.hidden;
+        this.advanced = data.advanced;
+        this.group = data.group;
+        // this.enumValues = this._getEnumValues(data);
+    }
+}
+export class Preferences extends Setting {
+    constructor() {
+        super(...arguments);
+        this.FILTER = 'preferences';
+    }
+    static { this.TAG = 'Preferences'; }
+}
+// class Setting(PlexObject):
+//     """ Represents a single Plex setting.
+//     _bool_cast = lambda x: True if x == 'true' or x == '1' else False
+//     _bool_str = lambda x: str(x).lower()
+//     _str = lambda x: str(x).encode('utf-8')
+//     TYPES = {
+//         'bool': {'type': bool, 'cast': _bool_cast, 'tostr': _bool_str},
+//         'double': {'type': float, 'cast': float, 'tostr': _str},
+//         'int': {'type': int, 'cast': int, 'tostr': _str},
+//         'text': {'type': str, 'cast': _str, 'tostr': _str},
+//     }
+//     def _loadData(self, data):
+//         """ Load attribute values from Plex XML response. """
+//         this._setValue = None
+//         this.id = data.('id')
+//         this.label = data.('label')
+//         this.summary = data.('summary')
+//         this.type = data.('type')
+//         this.default = this._cast(data.('default'))
+//         this.value = this._cast(data.('value'))
+//         this.hidden = utils.cast(bool, data.('hidden'))
+//         this.advanced = utils.cast(bool, data.('advanced'))
+//         this.group = data.('group')
+//         this.enumValues = this._getEnumValues(data)
+//     def _cast(self, value):
+//         """ Cast the specific value to the type of this setting. """
+//         if this.type != 'enum':
+//             value = utils.cast(this.TYPES.get(this.type)['cast'], value)
+//         return value
+//     def _getEnumValues(self, data):
+//         """ Returns a list of dictionary of valis value for this setting. """
+//         enumstr = data.('enumValues')
+//         if not enumstr:
+//             return None
+//         if ':' in enumstr:
+//             return {this._cast(k): v for k, v in [kv.split(':') for kv in enumstr.split('|')]}
+//         return enumstr.split('|')
+//     def set(self, value):
+//         """ Set a new value for this setitng. NOTE: You must call plex.settings.save() for before
+//             any changes to setting values are persisted to the :class:`~plexapi.server.PlexServer`.
+//         """
+//         # check a few things up front
+//         if not isinstance(value, this.TYPES[this.type]['type']):
+//             badtype = type(value).__name__
+//             raise BadRequest('Invalid value for %s: a %s is required, not %s' % (this.id, this.type, badtype))
+//         if this.enumValues and value not in this.enumValues:
+//             raise BadRequest('Invalid value for %s: %s not in %s' % (this.id, value, list(this.enumValues)))
+//         # store value off to the side until we call settings.save()
+//         tostr = this.TYPES[this.type]['tostr']
+//         this._setValue = tostr(value)
+//     def toUrl(self):
+//         """Helper for urls"""
+//         return '%s=%s' % (this.id, this._value or this.value)

package/dist/{util.d.ts → src/util.d.ts}

@@ -1,4 +1,4 @@
-import type { Section } from './library';
+import type { Section } from './library.js';
 export interface MediaContainer<T> {
     MediaContainer: T;
 }
@@ -17,3 +17,4 @@ export declare function getAgentIdentifier(section: Section, agent: string): Pro
 /** 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/{util.js → src/util.js}

@@ -1,17 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ltrim = exports.tagHelper = exports.getAgentIdentifier = exports.rsplit = void 0;
-function rsplit(str, sep, maxsplit) {
-    var split = str.split(sep);
+export function rsplit(str, sep, maxsplit) {
+    const split = str.split(sep);
     return maxsplit ? [split.slice(0, -maxsplit).join(sep)].concat(split.slice(-maxsplit)) : split;
 }
-exports.rsplit = rsplit;
 /**
  * Return the full agent identifier from a short identifier, name, or confirm full identifier.
  * @param section
  * @param agent
  */
-async function getAgentIdentifier(section, agent) {
+export async function getAgentIdentifier(section, agent) {
     const agents = [];
     for (const ag of await section.agents()) {
         const identifiers = [ag.identifier, ag.shortIdentifier, ag.name];
@@ -22,9 +18,8 @@ async function getAgentIdentifier(section, agent) {
     }
     throw new Error(`Couldnt find "${agent}" in agents list (${agents.join(', ')})`);
 }
-exports.getAgentIdentifier = getAgentIdentifier;
 /** Simple tag helper for editing a object. */
-function tagHelper(tag, items, locked = true, remove = false) {
+export function tagHelper(tag, items, locked = true, remove = false) {
     const data = {};
     if (remove) {
         const tagname = `${tag}[].tag.tag-`;
@@ -40,8 +35,7 @@ function tagHelper(tag, items, locked = true, remove = false) {
     data[`${tag}.locked`] = locked ? 1 : 0;
     return data;
 }
-exports.tagHelper = tagHelper;
-function ltrim(x, characters) {
+export function ltrim(x, characters) {
     let start = 0;
     while (characters.includes(x[start])) {
         start += 1;
@@ -49,4 +43,6 @@ function ltrim(x, characters) {
     const end = x.length - 1;
     return x.substr(start, end);
 }
-exports.ltrim = ltrim;
+export function lowerFirst(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}