@ctrl/plex 3.0.0 → 3.2.0

package/README.md

@@ -98,3 +98,41 @@ Post testing, remove plex server from account. Warning this is destructive. Do n
 ```sh
 npm run test-cleanup
 ```
+
+
+### Running tests locally (mostly for myself)
+
+get a claim token from https://www.plex.tv/claim/
+export PLEX_CLAIM_TOKEN=claim-token
+
+```
+docker run -d \
+  --name=plex \
+  --net=host \
+  -h orbstack \
+  -p 32400:32400/tcp \
+  -p 32400:32400 \
+  -p 1900:1900/udp \
+  -p 5353:5353/udp \
+  -p 8324:8324 \
+  -p 32410:32410/udp \
+  -p 32412:32412/udp \
+  -p 32413:32413/udp \
+  -p 32414:32414/udp \
+  -p 32469:32469 \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e TZ=Etc/UTC \
+  -e VERSION=docker \
+  -e PLEX_CLAIM=$PLEX_CLAIM_TOKEN \
+  -v /Users/scooper/gh/plex/plex/media/db:/config \
+  -v /Users/scooper/gh/plex/plex/media/transcode:/transcode \
+  -v /Users/scooper/gh/plex/plex/media:/data \
+  --restart unless-stopped \
+  lscr.io/linuxserver/plex:latest
+```
+
+bootstrap media
+```
+NODE_OPTIONS="--loader ts-node/esm" node scripts/bootstraptest.ts --no-docker --server-name=orbstack`
+```

package/dist/src/library.d.ts

@@ -260,7 +260,7 @@ export declare abstract class LibrarySection<SectionVideoType = VideoType> exten
     readonly VIDEO_TYPE: Class<SectionVideoType>;
     _filterTypes?: FilteringType[];
     _fieldTypes?: FilteringFieldType[];
-    all(sort?: string): Promise<any[]>;
+    all(sort?: string): Promise<SectionVideoType[]>;
     agents(): Promise<Agent[]>;
     /**
      * @param title Title of the item to return.

package/dist/src/library.js

@@ -283,7 +283,7 @@ export class LibrarySection extends PlexObject {
             sortStr = `?sort=${sort}`;
         }
         const key = `/library/sections/${this.key}/all${sortStr}`;
-        const items = await fetchItems(this.server, key);
+        const items = await fetchItems(this.server, key, undefined, this.VIDEO_TYPE, this);
         return items;
     }
     async agents() {

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

@@ -110,6 +110,7 @@ export interface MovieData {
     Extras?: ExtrasData[];
     Guid?: Guid[];
     Marker?: MarkerData[];
+    Rating?: MediaRating[];
 }
 export interface MediaTag {
     tag: string;
@@ -246,4 +247,15 @@ interface ExtrasStream {
     selected?: boolean;
     channels?: number;
 }
+interface MediaRating {
+    image: string;
+    /**
+     * ex 8.3
+     */
+    value: number;
+    /**
+     * ex 'audience'
+     */
+    type: string;
+}
 export {};

package/dist/src/media.d.ts

@@ -179,4 +179,25 @@ declare class GuidTag extends PlexObject {
 export declare class Guid extends GuidTag {
     static TAG: "Guid";
 }
+/**
+ * Represents a single Rating media tag.
+ */
+export declare class Rating extends PlexObject {
+    static TAG: "Rating";
+    /**
+     * The uri for the rating image
+     * (e.g. ``imdb://image.rating``, ``rottentomatoes://image.rating.ripe``,
+     * ``rottentomatoes://image.rating.upright``, ``themoviedb://image.rating``).
+     */
+    image: string;
+    /**
+     * The type of rating (e.g. audience or critic).
+     */
+    type: 'audience' | 'critic';
+    /**
+     * The rating value.
+     */
+    value: number;
+    protected _loadData(data: any): void;
+}
 export {};

package/dist/src/media.js

@@ -189,3 +189,14 @@ class GuidTag extends PlexObject {
 export class Guid extends GuidTag {
     static { this.TAG = 'Guid'; }
 }
+/**
+ * Represents a single Rating media tag.
+ */
+export class Rating extends PlexObject {
+    static { this.TAG = 'Rating'; }
+    _loadData(data) {
+        this.image = data.image;
+        this.type = data.type;
+        this.value = data.value;
+    }
+}

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, Role, Similar, Writer } from './media.js';
+import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, 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.
      */
@@ -95,6 +103,7 @@ export declare class Movie extends Video {
     media: Media[];
     guids: Guid[];
     markers: Marker[];
+    ratings?: Rating[];
     get actors(): Role[];
     locations(): Promise<string[]>;
     /**

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, Role, Similar, Writer, } from './media.js';
+import { Chapter, Collection, Country, Director, Genre, Guid, Marker, Media, Producer, Rating, Role, Similar, Writer, } from './media.js';
 class Video extends Playable {
     constructor() {
         super(...arguments);
@@ -71,6 +71,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;
     }
 }
 /**
@@ -143,6 +146,7 @@ export class Movie extends Video {
         this.media = data.Media?.map(d => new Media(this.server, d, undefined, this)) ?? [];
         this.guids = data.Guid?.map(d => new Guid(this.server, d, undefined, this)) ?? [];
         this.markers = data.Marker?.map(d => new Marker(this.server, d, undefined, this)) ?? [];
+        this.ratings = data.Rating?.map(d => new Rating(this.server, d, undefined, this)) ?? [];
     }
     _loadFullData(data) {
         const metadata = data.Metadata[0];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/plex",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "plex api client in typescript",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "publishConfig": {
@@ -20,10 +20,10 @@
     "typescript"
   ],
   "scripts": {
-    "lint": "pnpm run '/^(lint:biome|lint:eslint)$/'",
+    "lint": "npm run lint:biome && npm run lint:eslint",
     "lint:biome": "biome check .",
     "lint:eslint": "eslint --ext .ts,.tsx .",
-    "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
+    "lint:fix": "npm run lint:biome:fix && npm run lint:eslint:fix",
     "lint:eslint:fix": "eslint --ext .ts,.tsx . --fix",
     "lint:biome:fix": "biome check . --apply",
     "prepare": "npm run build",
@@ -33,7 +33,6 @@
     "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml",
     "bootstraptest": "node --loader ts-node/esm scripts/bootstraptest.ts",
     "teardowntest": "node --loader ts-node/esm scripts/teardowntest.ts",
-    "claim-server": "node --loader ts-node/esm scripts/claim-server.ts",
     "add-media": "node --loader ts-node/esm scripts/add-media.ts",
     "test-cleanup": "node --loader ts-node/esm scripts/test-cleanup.ts"
   },
@@ -41,34 +40,34 @@
     "@ctrl/mac-address": "^3.0.3",
     "ofetch": "^1.3.4",
     "p-any": "^4.0.0",
-    "type-fest": "^4.17.0",
+    "type-fest": "^4.18.1",
     "ws": "^8.17.0",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.7.1",
+    "@biomejs/biome": "1.7.2",
     "@ctrl/eslint-config-biome": "2.6.7",
     "@sindresorhus/tsconfig": "5.0.0",
-    "@types/lodash": "4.17.0",
+    "@types/lodash": "4.17.1",
     "@types/micromatch": "4.0.7",
-    "@types/node": "20.12.7",
+    "@types/node": "20.12.8",
     "@types/ws": "8.5.10",
     "@types/xml2js": "0.4.14",
     "@types/yargs": "17.0.32",
-    "@vitest/coverage-v8": "1.5.2",
+    "@vitest/coverage-v8": "1.6.0",
     "delay": "6.0.0",
     "eslint": "8.57.0",
     "execa": "8.0.1",
     "glob": "10.3.12",
     "globby": "14.0.1",
     "lodash": "4.17.21",
-    "make-dir": "4.0.0",
+    "make-dir": "5.0.0",
     "ora": "8.0.1",
     "p-retry": "6.2.0",
     "ts-node": "10.9.2",
     "typedoc": "0.25.13",
     "typescript": "5.4.5",
-    "vitest": "1.5.2",
+    "vitest": "1.6.0",
     "yargs": "17.7.2"
   },
   "release": {