@ctrl/plex 1.5.2 → 2.0.0

package/dist/{library.types.d.ts → src/library.types.d.ts}

@@ -1,4 +1,4 @@
-import { ChapterSource, MediaTagData } from './video.types';
+import { ChapterSource, MarkerData, MediaTagData } from './video.types.js';
 export interface LibraryRootResponse {
     size: number;
     allowSync: boolean;
@@ -32,6 +32,7 @@ export interface SectionsDirectory {
     refreshing: boolean;
     thumb: string;
     key: string;
+    ratingKey: string;
     type: string;
     title: string;
     agent: string;
@@ -106,6 +107,9 @@ export interface MovieData {
     Role?: MediaTag[];
     Similar?: MediaTagData[];
     Producer?: MediaTagData[];
+    Extras?: ExtrasData[];
+    Guid?: Guid[];
+    Marker?: MarkerData[];
 }
 export interface MediaTag {
     tag: string;
@@ -117,6 +121,9 @@ export interface Media {
     videoProfile: string;
     Part: Part[];
 }
+export interface Guid {
+    id: string;
+}
 export interface Part {
     id: number;
     key: string;
@@ -126,6 +133,17 @@ export interface Part {
     container: string;
     videoProfile: string;
 }
+export interface FullShowData {
+    size: number;
+    allowSync: boolean;
+    identifier: string;
+    librarySectionID: number;
+    librarySectionTitle: string;
+    librarySectionUUID: string;
+    mediaTagPrefix: string;
+    mediaTagVersion: number;
+    Metadata: ShowData[];
+}
 export interface ShowData {
     ratingKey: string;
     key: string;
@@ -177,3 +195,55 @@ export interface CollectionData {
     maxYear: string;
     minYear: string;
 }
+export interface ExtrasData {
+    ratingKey: string;
+    key: string;
+    guid: string;
+    type: string;
+    title: string;
+    titleSort: string;
+    summary: string;
+    index: number;
+    thumb: string;
+    subtype: string;
+    duration: number;
+    addedAt: number;
+    extraType: number;
+    Media: ExtrasMedia[];
+}
+export interface ExtrasMedia {
+    id: number;
+    duration: number;
+    bitrate: number;
+    width: number;
+    height: number;
+    aspectRatio: number;
+    audioCodec: string;
+    videoCodec: string;
+    videoResolution: string;
+    container: string;
+    optimizedForStreaming: number;
+    protocol: string;
+    premium: boolean;
+    Part: Array<{
+        id: number;
+        duration: number;
+        container: string;
+        key: string;
+        Stream: ExtrasStream[];
+    }>;
+}
+interface ExtrasStream {
+    id: number;
+    streamType: number;
+    codec: string;
+    index: number;
+    bitrate?: number;
+    height?: number;
+    width?: number;
+    displayTitle: string;
+    extendedDisplayTitle: string;
+    selected?: boolean;
+    channels?: number;
+}
+export {};

package/dist/src/library.types.js

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

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

@@ -1,5 +1,5 @@
-import { PlexObject } from './base/plexObject';
-import { ChapterData, MarkerData, MediaData, MediaPartData, MediaPartStreamData } from './video.types';
+import { PlexObject } from './base/plexObject.js';
+import { ChapterData, MarkerData, MediaData, MediaPartData, MediaPartStreamData } from './video.types.js';
 /**
  * Base class for media tags used for filtering and searching your library
  * items or navigating the metadata of media items in your library. Tags are
@@ -67,7 +67,6 @@ export declare class MediaPart extends PlexObject {
     file: string;
     id: number;
     indexes: string;
-    key: string;
     size: number;
     optimizedForStreaming: boolean;
     syncItemId: string;
@@ -134,7 +133,7 @@ export declare class Producer extends MediaTag {
 export declare class Marker extends MediaTag {
     static TAG: "Marker";
     FILTER: "marker";
-    type: 'intro';
+    type: 'intro' | 'credits';
     startTimeOffset: number;
     endTimeOffset: number;
     protected _loadData(data: MarkerData): void;
@@ -167,4 +166,17 @@ export declare class Optimized extends PlexObject {
     targetTagID: any;
     protected _loadData(data: any): void;
 }
+/**
+ * Base class for guid tags used only for Guids, as they contain only a string identifier
+ */
+declare class GuidTag extends PlexObject {
+    /**
+     * The guid for external metadata sources (e.g. IMDB, TMDB, TVDB). ex - imdb://tt3222784
+     */
+    id: string;
+    protected _loadData(data: any): void;
+}
+export declare class Guid extends GuidTag {
+    static TAG: "Guid";
+}
 export {};

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

@@ -1,13 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Optimized = exports.Collection = exports.Chapter = exports.Marker = exports.Producer = exports.Similar = exports.Director = exports.Writer = exports.Country = exports.Genre = exports.Role = exports.MediaPartStream = exports.MediaPart = exports.Media = void 0;
-const plexObject_1 = require("./base/plexObject");
+import { PlexObject } from './base/plexObject.js';
 /**
  * Base class for media tags used for filtering and searching your library
  * items or navigating the metadata of media items in your library. Tags are
  * the construct used for things such as Country, Director, Genre, etc.
  */
-class MediaTag extends plexObject_1.PlexObject {
+class MediaTag extends PlexObject {
     // async items(): Promise<any[]> {
     //   if (!this.key) {
     //     throw new Error(`Key is not defined for this tag: ${this.tag}`);
@@ -21,7 +18,8 @@ class MediaTag extends plexObject_1.PlexObject {
         this.tag = data.tag;
     }
 }
-class Media extends plexObject_1.PlexObject {
+export class Media extends PlexObject {
+    static { this.TAG = 'Media'; }
     _loadData(data) {
         this.aspectRatio = data.aspectRatio;
         this.audioChannels = data.audioChannels;
@@ -40,11 +38,9 @@ class Media extends plexObject_1.PlexObject {
         this.parts = data.Part.map(part => new MediaPart(this.server, part, undefined, this));
     }
 }
-exports.Media = Media;
-Media.TAG = 'Media';
-class MediaPart extends plexObject_1.PlexObject {
+export class MediaPart extends PlexObject {
+    static { this.TAG = 'Part'; }
     _loadData(data) {
-        var _a, _b;
         this.container = data.container;
         this.duration = data.duration;
         this.file = data.file;
@@ -55,12 +51,11 @@ class MediaPart extends plexObject_1.PlexObject {
         this.videoProfile = data.videoProfile;
         this.exists = data.exists;
         this.streams =
-            (_b = (_a = data.Stream) === null || _a === void 0 ? void 0 : _a.map(stream => new MediaPartStream(this.server, stream, undefined, this))) !== null && _b !== void 0 ? _b : [];
+            data.Stream?.map(stream => new MediaPartStream(this.server, stream, undefined, this)) ?? [];
     }
 }
-exports.MediaPart = MediaPart;
-MediaPart.TAG = 'Part';
-class MediaPartStream extends plexObject_1.PlexObject {
+export class MediaPartStream extends PlexObject {
+    static { this.TAG = 'Stream'; }
     _loadData(data) {
         this.id = data.id;
         this.codec = data.codec;
@@ -71,120 +66,109 @@ class MediaPartStream extends plexObject_1.PlexObject {
         this.streamType = data.streamType;
     }
 }
-exports.MediaPartStream = MediaPartStream;
-MediaPartStream.TAG = 'Stream';
 /**
  * Represents a single Role (actor/actress) media tag.
  */
-class Role extends MediaTag {
+export class Role extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'role';
     }
+    static { this.TAG = 'Role'; }
 }
-exports.Role = Role;
-Role.TAG = 'Role';
 /**
  * Represents a single Genre media tag.
  */
-class Genre extends MediaTag {
+export class Genre extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'genre';
     }
+    static { this.TAG = 'Genre'; }
 }
-exports.Genre = Genre;
-Genre.TAG = 'Genre';
 /**
  * Represents a single Country media tag.
  */
-class Country extends MediaTag {
+export class Country extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'country';
     }
+    static { this.TAG = 'Country'; }
 }
-exports.Country = Country;
-Country.TAG = 'Country';
 /**
  * Represents a single Writer media tag.
  */
-class Writer extends MediaTag {
+export class Writer extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'writer';
     }
+    static { this.TAG = 'Writer'; }
 }
-exports.Writer = Writer;
-Writer.TAG = 'Writer';
 /**
  * Represents a single Director media tag.
  */
-class Director extends MediaTag {
+export class Director extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'director';
     }
+    static { this.TAG = 'Director'; }
 }
-exports.Director = Director;
-Director.TAG = 'Director';
-class Similar extends MediaTag {
+export class Similar extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'similar';
     }
+    static { this.TAG = 'Similar'; }
 }
-exports.Similar = Similar;
-Similar.TAG = 'Similar';
-class Producer extends MediaTag {
+export class Producer extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'producer';
     }
+    static { this.TAG = 'Producer'; }
 }
-exports.Producer = Producer;
-Producer.TAG = 'Producer';
-class Marker extends MediaTag {
+export class Marker extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'marker';
     }
+    static { this.TAG = 'Marker'; }
     _loadData(data) {
         this.type = data.type;
         this.startTimeOffset = data.startTimeOffset;
         this.endTimeOffset = data.endTimeOffset;
     }
 }
-exports.Marker = Marker;
-Marker.TAG = 'Marker';
 /**
  * Represents a single Chapter media tag.
  */
-class Chapter extends MediaTag {
+export class Chapter extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'chapter';
     }
+    static { this.TAG = 'Chapter'; }
     _loadData(data) {
         this.startTimeOffset = data.startTimeOffset;
         this.endTimeOffset = data.endTimeOffset;
         this.thumb = data.thumb;
     }
 }
-exports.Chapter = Chapter;
-Chapter.TAG = 'Chapter';
 /**
  * Represents a single Collection media tag.
  */
-class Collection extends MediaTag {
+export class Collection extends MediaTag {
     constructor() {
         super(...arguments);
         this.FILTER = 'collection';
     }
+    static { this.TAG = 'Collection'; }
 }
-exports.Collection = Collection;
-Collection.TAG = 'Collection';
-class Optimized extends plexObject_1.PlexObject {
+export class Optimized extends PlexObject {
+    static { this.TAG = 'Item'; }
     _loadData(data) {
         this.id = data.id;
         this.composite = data.composite;
@@ -194,5 +178,14 @@ class Optimized extends plexObject_1.PlexObject {
         this.targetTagID = data.targetTagID;
     }
 }
-exports.Optimized = Optimized;
-Optimized.TAG = 'Item';
+/**
+ * Base class for guid tags used only for Guids, as they contain only a string identifier
+ */
+class GuidTag extends PlexObject {
+    _loadData(data) {
+        this.id = data.id;
+    }
+}
+export class Guid extends GuidTag {
+    static { this.TAG = 'Guid'; }
+}

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

@@ -0,0 +1,7 @@
+export interface SearchResultData {
+    guid: string;
+    name: string;
+    score: number;
+    year: number;
+    lifespanEnded: boolean;
+}

package/dist/src/media.types.js

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

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

@@ -1,6 +1,6 @@
-import { ResourcesResponse, Connection, Device } from './myplex.types';
-import { PlexServer } from './server';
-import { PlexObject } from './base/plexObject';
+import { PlexObject } from './base/plexObject.js';
+import { Connection, Device, ResourcesResponse } from './myplex.types.js';
+import { PlexServer } from './server.js';
 /**
  * MyPlex account and profile information. This object represents the data found Account on
  * the myplex.tv servers at the url https://plex.tv/users/account. You may create this object
@@ -10,9 +10,9 @@ import { PlexObject } from './base/plexObject';
  */
 export declare class MyPlexAccount {
     private readonly baseUrl;
-    username?: string | undefined;
+    username?: string;
     private readonly password?;
-    token?: string | undefined;
+    token?: string;
     private readonly timeout;
     private readonly server?;
     static key: string;
@@ -82,7 +82,7 @@ export declare class MyPlexAccount {
      * @param timeout timeout in seconds on initial connect to myplex
      * @param server not often available
      */
-    constructor(baseUrl?: string | null, username?: string | undefined, password?: string | undefined, token?: string | undefined, timeout?: number, server?: PlexServer | undefined);
+    constructor(baseUrl?: string | null, username?: string, password?: string, token?: string, timeout?: number, server?: PlexServer);
     /**
      * Returns a new :class:`~server.PlexServer` or :class:`~client.PlexClient` object.
      * Often times there is more than one address specified for a server or client.
@@ -96,6 +96,11 @@ export declare class MyPlexAccount {
      */
     resource(name: string): Promise<MyPlexResource>;
     resources(): Promise<MyPlexResource[]>;
+    /**
+     * @param name Name to match against.
+     * @param clientId clientIdentifier to match against.
+     */
+    device(name?: string, clientId?: string): Promise<MyPlexDevice>;
     /**
      * Returns a list of all :class:`~plexapi.myplex.MyPlexDevice` objects connected to the server.
      */
@@ -218,5 +223,10 @@ export declare class MyPlexDevice extends PlexObject {
     lastSeenAt: Date;
     /** List of connection URIs for the device. */
     connections?: string[];
+    connect(): Promise<PlexServer>;
+    /**
+     * Remove this device from your account
+     */
+    delete(): Promise<void>;
     protected _loadData(data: Device): void;
 }