@ctrl/plex 3.4.0 → 3.5.0

package/README.md

@@ -105,7 +105,8 @@ npm run test-cleanup
 get a claim token from https://www.plex.tv/claim/
 export PLEX_CLAIM_TOKEN=claim-token
 
-```
+start plex container for testing
+```console
 docker run -d \
   --name=plex \
   --net=host \
@@ -132,7 +133,12 @@ docker run -d \
   lscr.io/linuxserver/plex:latest
 ```
 
-bootstrap media
+Pull latest plex container if needed
+```console
+docker pull lscr.io/linuxserver/plex:latest
 ```
-NODE_OPTIONS="--loader ts-node/esm" node scripts/bootstraptest.ts --no-docker --server-name=orbstack`
+
+bootstrap plex server with test media
+```console
+NODE_OPTIONS="--loader ts-node/esm" node scripts/bootstraptest.ts --no-docker --server-name=orbstack --password=$PLEX_PASSWORD --username=$PLEX_USERNAME
 ```

package/dist/src/alert.d.ts

@@ -1,6 +1,6 @@
 import WebSocket from 'ws';
-import { AlertTypes } from './alert.types.js';
-import { PlexServer } from './server.js';
+import type { AlertTypes } from './alert.types.js';
+import type { PlexServer } from './server.js';
 export declare class AlertListener {
     private readonly server;
     callback: (data: AlertTypes) => void;

package/dist/src/client.d.ts

@@ -1,5 +1,5 @@
 import { URL } from 'url';
-import { Player } from './client.types.js';
+import type { Player } from './client.types.js';
 export interface PlexOptions {
     /** (:class:`~plexapi.server.PlexServer`): PlexServer this client is connected to (optional). */
     server?: any;

package/dist/src/library.d.ts

@@ -1,12 +1,12 @@
-import { Class } from 'type-fest';
+import type { Class } from 'type-fest';
 import { PartialPlexObject } from './base/partialPlexObject.js';
 import { PlexObject } from './base/plexObject.js';
-import { CollectionData, LibraryRootResponse, Location, SectionsDirectory } from './library.types.js';
+import type { CollectionData, LibraryRootResponse, Location, SectionsDirectory } from './library.types.js';
 import { Playlist } from './playlist.js';
-import { Agent, SEARCHTYPES } from './search.js';
-import { SearchResult } from './search.types.js';
+import { type Agent, type SEARCHTYPES } from './search.js';
+import type { SearchResult } from './search.types.js';
 import type { PlexServer } from './server.js';
-import { Movie, Show, VideoType } from './video.js';
+import { Movie, Show, type VideoType } from './video.js';
 export type Section = MovieSection | ShowSection;
 export declare class Library {
     private readonly server;
@@ -364,7 +364,7 @@ export declare abstract class LibrarySection<SectionVideoType = VideoType> exten
     folders(): Promise<Folder[]>;
     genres(): Promise<FilterChoice[]>;
     /**
-     * Returns a list of available {@link FilteringFields} for a specified libtype.
+     * Returns a list of available {@link FilteringField} for a specified libtype.
      * This is the list of options in the custom filter dropdown menu
      */
     listFields(libtype?: Libtype): Promise<FilteringField[]>;

package/dist/src/library.js

@@ -483,7 +483,7 @@ export class LibrarySection extends PlexObject {
         return fetchItems(this.server, key, undefined, FilterChoice);
     }
     /**
-     * Returns a list of available {@link FilteringFields} for a specified libtype.
+     * Returns a list of available {@link FilteringField} for a specified libtype.
      * This is the list of options in the custom filter dropdown menu
      */
     async listFields(libtype = this.type) {
@@ -494,7 +494,7 @@ export class LibrarySection extends PlexObject {
         const filter = filterTypes.find(f => f.type === libtype);
         if (!filter) {
             throw new NotFound(`Unknown libtype "${libtype}" for this library.
-        Available libtypes: ${filterTypes.join(', ')}`);
+        Available libtypes: ${filterTypes.map(f => f.type).join(', ')}`);
         }
         return filter;
     }

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

@@ -1,4 +1,4 @@
-import { ChapterSource, MarkerData, MediaTagData } from './video.types.js';
+import type { ChapterSource, MarkerData, MediaTagData } from './video.types.js';
 export interface LibraryRootResponse {
     size: number;
     allowSync: boolean;

package/dist/src/media.d.ts

@@ -1,5 +1,5 @@
 import { PlexObject } from './base/plexObject.js';
-import { ChapterData, MarkerData, MediaData, MediaPartData, MediaPartStreamData } from './video.types.js';
+import type { 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

package/dist/src/media.js

@@ -186,7 +186,6 @@ class GuidTag extends PlexObject {
         this.id = data.id;
     }
 }
-// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
 export class Guid extends GuidTag {
     static { this.TAG = 'Guid'; }
 }
@@ -235,21 +234,18 @@ class BaseResource extends PlexObject {
 /**
  * Represents a single Art object.
  */
-// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
 export class Art extends BaseResource {
     static { this.TAG = 'Art'; }
 }
 /**
  * Represents a single Poster object.
  */
-// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
 export class Poster extends BaseResource {
     static { this.TAG = 'Photo'; }
 }
 /**
  * Represents a single Theme object.
  */
-// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
 export class Theme extends BaseResource {
     static { this.TAG = 'Theme'; }
 }

package/dist/src/myplex.js

@@ -133,7 +133,6 @@ export class MyPlexAccount {
             this._loadData(data);
             return this;
         }
-        // log('Logging in with token');
         const data = await this.query(MyPlexAccount.key);
         this._loadData(data);
         return this;

package/dist/src/playlist.d.ts

@@ -1,8 +1,8 @@
 import { Playable } from './base/playable.js';
 import type { Section } from './library.js';
-import { PlaylistResponse } from './playlist.types.js';
+import type { PlaylistResponse } from './playlist.types.js';
 import type { PlexServer } from './server.js';
-import { Episode, Movie, VideoType } from './video.js';
+import { Episode, Movie, type VideoType } from './video.js';
 interface CreateRegularPlaylistOptions {
     /** True to create a smart playlist */
     smart?: false;

package/dist/src/search.d.ts

@@ -1,6 +1,6 @@
-import { ValueOf } from 'type-fest';
+import type { ValueOf } from 'type-fest';
 import { PlexObject } from './base/plexObject.js';
-import { MatchSearchResult } from './search.types.js';
+import type { MatchSearchResult } from './search.types.js';
 export declare class SearchResult extends PlexObject {
     static TAG: string;
     guid: string;

package/dist/src/server.d.ts

@@ -4,7 +4,7 @@ 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 type { 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

package/dist/src/video.d.ts

@@ -1,8 +1,8 @@
-import { URL } from 'url';
+import type { URL } from 'url';
 import { Playable } from './base/playable.js';
-import { ExtrasData, FullShowData, MovieData, ShowData } from './library.types.js';
+import type { ExtrasData, FullShowData, MovieData, ShowData } from './library.types.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';
+import type { ChapterSource, EpisodeMetadata, FullMovieResponse } from './video.types.js';
 export type VideoType = Movie | Show;
 declare abstract class Video extends Playable {
     /** Datetime this item was added to the library. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/plex",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "plex api client in typescript",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "publishConfig": {
@@ -37,32 +37,32 @@
     "test-cleanup": "node --loader ts-node/esm scripts/test-cleanup.ts"
   },
   "dependencies": {
-    "@ctrl/mac-address": "^3.0.3",
-    "ofetch": "^1.3.4",
+    "@ctrl/mac-address": "^3.1.0",
+    "ofetch": "^1.4.1",
     "p-any": "^4.0.0",
-    "type-fest": "^4.24.0",
-    "ws": "^8.18.0",
+    "type-fest": "^4.40.1",
+    "ws": "^8.18.2",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.8.3",
-    "@ctrl/eslint-config-biome": "4.1.3",
-    "@sindresorhus/tsconfig": "6.0.0",
-    "@types/node": "22.3.0",
-    "@types/ws": "8.5.12",
+    "@biomejs/biome": "1.9.4",
+    "@ctrl/eslint-config-biome": "4.4.0",
+    "@sindresorhus/tsconfig": "7.0.0",
+    "@types/node": "22.15.3",
+    "@types/ws": "8.18.1",
     "@types/xml2js": "0.4.14",
     "@types/yargs": "17.0.33",
-    "@vitest/coverage-v8": "2.0.5",
-    "eslint": "9.9.0",
-    "execa": "9.3.1",
-    "globby": "14.0.2",
+    "@vitest/coverage-v8": "3.1.2",
+    "eslint": "9.26.0",
+    "execa": "9.5.2",
+    "globby": "14.1.0",
     "make-dir": "5.0.0",
-    "ora": "8.0.1",
-    "p-retry": "6.2.0",
+    "ora": "8.2.0",
+    "p-retry": "6.2.1",
     "ts-node": "10.9.2",
-    "typedoc": "0.26.5",
-    "typescript": "5.5.4",
-    "vitest": "2.0.5",
+    "typedoc": "0.28.3",
+    "typescript": "5.8.3",
+    "vitest": "3.1.2",
     "yargs": "17.7.2"
   },
   "release": {
@@ -72,5 +72,6 @@
   },
   "engines": {
     "node": ">=18"
-  }
+  },
+  "packageManager": "pnpm@10.10.0"
 }