@ctrl/plex 1.5.3 → 2.0.0

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);
+}

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

@@ -1,40 +1,29 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { URL } from 'url';
-import { Playable } from './base/playable';
-import { FullShowData, MovieData, ShowData } from './library.types';
-import { PlexServer } from './server';
-import { Director, Country, Writer, Chapter, Collection, Genre, Role, Media, Similar, Producer, Marker } from './media';
-import { FullMovieResponse, ChapterSource, EpisodeMetadata } from './video.types';
-export declare type VideoType = Movie | Show;
+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 { ChapterSource, EpisodeMetadata, FullMovieResponse } from './video.types.js';
+export type VideoType = Movie | Show;
 declare abstract class Video extends Playable {
-    server: PlexServer;
-    /** API URL (/library/metadata/<ratingkey>) */
-    key: string;
     /** Datetime this item was added to the library. */
     addedAt: Date;
     /** Datetime item was last accessed. */
     lastViewedAt?: Date;
     /** Hardcoded as 'video' (useful for search filters). */
     listType: "video";
-    /** Unique key identifying this item. */
-    ratingKey: string;
     /** Summary of the artist, track, or album. */
     summary: string;
     /** URL to thumbnail image. */
     thumb: string;
-    /** Artist, Album or Track title. (Jason Mraz, We Sing, Lucky, etc.) */
-    title: string;
     /** Title to use when sorting (defaults to title). */
     titleSort?: string;
-    /** 'artist', 'album', or 'track'. */
-    type: string;
     /** Datetime this item was updated. */
     updatedAt?: Date;
     /** Count of times this item was accessed. */
     viewCount?: number;
     art?: string;
     grandparentArt?: string;
-    constructor(server: PlexServer, data: MovieData | EpisodeMetadata, initpath: string, parent?: any);
     /**
      * Returns True if this video is watched.
      */
@@ -54,6 +43,7 @@ declare abstract class Video extends Playable {
      */
     markUnwatched(): Promise<void>;
     rate(rate: number): Promise<void>;
+    extras(): Promise<Extra[]>;
     protected _loadData(data: MovieData | ShowData | EpisodeMetadata): void;
 }
 /**
@@ -63,9 +53,6 @@ export declare class Movie extends Video {
     TAG: string;
     TYPE: string;
     METADATA_TYPE: string;
-    /** Key to movie artwork (/library/metadata/<ratingkey>/art/<artid>) */
-    art: string;
-    librarySectionID?: number;
     /** Audience rating (usually from Rotten Tomatoes). */
     audienceRating?: number;
     /** Key to audience rating image (rottentomatoes://image.rating.spilled) */
@@ -78,8 +65,8 @@ export declare class Movie extends Video {
     duration: number;
     /** Original title, often the foreign title (転々; 엽기적인 그녀). */
     originalTitle?: string;
-    /** Datetime movie was released. */
-    originallyAvailableAt: Date;
+    /** YYYY-MM-DD movie was released. */
+    originallyAvailableAt: string;
     /** Primary extra key (/library/metadata/66351). */
     primaryExtraKey: string;
     /** Movie rating (7.9; 9.8; 8.1). */
@@ -94,8 +81,6 @@ export declare class Movie extends Video {
     userRating?: number;
     /** View offset in milliseconds. */
     viewOffset: number;
-    /** Year movie was released. */
-    year: number;
     /** Plex GUID (com.plexapp.agents.imdb://tt4302938?lang=en) */
     guid: string;
     directors: Director[];
@@ -108,8 +93,18 @@ export declare class Movie extends Video {
     roles: Role[];
     similar: Similar[];
     media: Media[];
+    guids: Guid[];
+    markers: Marker[];
     get actors(): Role[];
     locations(): Promise<string[]>;
+    /**
+     * Returns True if this movie has an intro marker
+     */
+    hasIntroMarker(): Promise<boolean>;
+    /**
+     * Returns True if this movie has a credits marker
+     */
+    hasCreditsMarker(): Promise<boolean>;
     protected _loadData(data: MovieData): void;
     protected _loadFullData(data: FullMovieResponse): void;
 }
@@ -120,8 +115,6 @@ export declare class Show extends Video {
     TAG: string;
     TYPE: string;
     METADATA_TYPE: string;
-    /** Key to show artwork (/library/metadata/<ratingkey>/art/<artid>) */
-    art: string;
     /** Key to banner artwork (/library/metadata/<ratingkey>/art/<artid>) */
     banner: string;
     /** Unknown. */
@@ -147,8 +140,6 @@ export declare class Show extends Video {
     theme: string;
     /** Unknown. */
     viewedLeafCount: number;
-    /** Year the show was released. */
-    year: number;
     /** List of genre objects. */
     genres: Genre[];
     /** List of role objects. */
@@ -195,24 +186,16 @@ export declare class Season extends Video {
     protected _loadData(data: ShowData): void;
     protected _loadFullData(data: ShowData): void;
 }
-declare class Episode extends Video {
+export declare class Episode extends Video {
     static TAG: string;
     TYPE: string;
     METADATA_TYPE: string;
-    /**
-     * Name of this Episode
-     */
-    title: string;
-    /** Key to episode artwork (/library/metadata/<ratingkey>/art/<artid>) */
-    art: string;
     /** Unknown (media). */
     chapterSource?: string;
     /** Content rating (PG-13; NR; TV-G). */
     contentRating: string;
     /**  Duration of episode in milliseconds. */
     duration: number;
-    /** Key to this episodes :class:`~plexapi.video.Show` artwork. */
-    grandparentArt: string;
     /** Key to this episodes :class:`~plexapi.video.Show`. */
     grandparentKey: string;
     /** Unique key for this episodes :class:`~plexapi.video.Show`. */
@@ -243,35 +226,12 @@ declare class Episode extends Video {
     rating: number;
     /**  View offset in milliseconds. */
     viewOffset?: number;
-    /**  Year episode was released. */
-    year: number;
     writers: Writer[];
     directors: Director[];
     media: Media[];
     collections: Collection[];
     chapters: Chapter[];
     markers: Marker[];
-    protected _INCLUDES: {
-        checkFiles: number;
-        includeAllConcerts: number;
-        includeBandwidths: number;
-        includeChapters: number;
-        includeChildren: number;
-        includeConcerts: number;
-        includeExternalMedia: number;
-        includeExtras: number;
-        includeFields: string;
-        includeGeolocation: number;
-        includeLoudnessRamps: number;
-        includeMarkers: number;
-        includeOnDeck: number;
-        includePopularLeaves: number;
-        includePreferences: number;
-        includeRelated: number;
-        includeRelatedCount: number;
-        includeReviews: number;
-        includeStations: number;
-    };
     /**
      * Returns this episodes season number.
      */
@@ -284,9 +244,27 @@ declare class Episode extends Video {
      * Returns True if this episode has an intro marker
      */
     hasIntroMarker(): Promise<boolean>;
+    /**
+     * Returns True if this episode has a credits marker
+     */
+    hasCreditsMarker(): Promise<boolean>;
     protected _loadData(data: EpisodeMetadata): void;
     protected _loadFullData(data: {
         Metadata: EpisodeMetadata[];
     }): void;
 }
+export declare class Clip extends Video {
+    static TAG: string;
+    TYPE: string;
+    METADATA_TYPE: string;
+    protected _loadData(data: any): void;
+    protected _loadFullData(data: any): void;
+}
+/**
+ * Represents a single Extra (trailer, behindTheScenes, etc).
+ */
+export declare class Extra extends Clip {
+    protected _loadData(data: ExtrasData): void;
+    protected _loadFullData(data: any): void;
+}
 export {};