@ctrl/plex 3.1.0 → 3.3.0

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

@@ -200,3 +200,52 @@ 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.
+ */
+export class Art extends BaseResource {
+    static { this.TAG = 'Art'; }
+}
+/**
+ * Represents a single Poster object.
+ */
+export class Poster extends BaseResource {
+    static { this.TAG = 'Photo'; }
+}
+/**
+ * Represents a single Theme object.
+ */
+export class Theme extends BaseResource {
+    static { this.TAG = 'Theme'; }
+}

package/dist/src/server.d.ts

@@ -172,7 +172,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',
         });

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, 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 {
@@ -24,6 +24,14 @@ declare abstract class Video extends Playable {
     viewCount?: number;
     art?: string;
     grandparentArt?: string;
+    /**
+     * BlurHash string for artwork image.
+     */
+    artBlurHash?: string;
+    /**
+     * BlurHash string for thumbnail image.
+     */
+    thumbBlurHash?: string;
     /**
      * Returns True if this video is watched.
      */
@@ -44,6 +52,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;
@@ -71,6 +100,9 @@ class Video extends Playable {
         this.titleSort = data.titleSort ?? this.title;
         this.viewCount = data.viewCount;
         this.playlistItemID = data.playlistItemID;
+        // todo: update one of them with this property
+        this.artBlurHash = data.artBlurHash;
+        this.thumbBlurHash = data.thumbBlurHash;
     }
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/plex",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "description": "plex api client in typescript",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "publishConfig": {