@redseat/api 0.0.16 → 0.0.18

package/dist/interfaces.d.ts

@@ -95,62 +95,84 @@ export interface ILibrary {
     status?: string;
 }
 export interface ITag {
-    id?: string;
+    id: string;
     name: string;
+    path: string;
     parent?: string;
-    path?: string;
-    count?: number;
-    starred?: boolean;
-    hidden?: boolean;
+    type?: string;
+    modified: number;
+    added: number;
+    generated: boolean;
     alt?: string[];
-    generated?: boolean;
-    waiting?: boolean;
+    thumb?: string;
+    params?: any;
 }
 export declare enum LinkType {
     'profile' = "profile",
     'post' = "post",
     'other' = "other"
 }
+export interface RsLink {
+    platform: string;
+    type?: LinkType;
+    id: string;
+    file?: string;
+    user?: string;
+    plugin?: string;
+}
+export type Gender = 'Male' | 'Female' | 'Animal' | 'Other' | 'Unknown' | {
+    Custom: string;
+};
 export interface IPerson {
-    id?: string;
+    id: string;
     name: string;
+    modified: number;
+    added: number;
+    posterv: number;
+    generated: boolean;
     alt?: string[];
-    socials?: {
-        id: string;
-        type: LinkType | undefined;
-        platform: string;
-    }[];
-    posterv?: number;
-    portrait?: boolean;
+    type?: string;
+    portrait?: string;
     birthday?: number;
-    waiting?: boolean;
-    generated?: boolean;
+    death?: number;
+    imdb?: string;
+    slug?: string;
+    tmdb?: number;
+    trakt?: number;
+    socials?: RsLink[];
+    gender?: Gender;
+    country?: string;
+    bio?: string;
+    params?: any;
 }
+export type SerieStatus = 'returning' | 'inProduction' | 'postProduction' | 'planned' | 'rumored' | 'ended' | 'released' | 'canceled' | 'pilot' | 'unknown' | {
+    other: string;
+};
 export interface ISerie {
-    id?: string;
+    id: string;
     name: string;
+    type?: string;
     alt?: string[];
-    tags?: string[];
-    people?: string[];
+    status?: SerieStatus;
+    params?: any;
     year?: number;
-    poster?: boolean;
     imdb?: string;
     slug?: string;
     tmdb?: number;
     trakt?: number;
     tvdb?: number;
     otherids?: string;
-    status?: string;
     imdbRating?: number;
     imdbVotes?: number;
-    images?: {
-        poster?: string;
-        background?: string;
-    };
-    posterv?: number;
-    backgroundv?: number;
-    cardv?: number;
-    waiting?: boolean;
+    traktRating?: number;
+    traktVotes?: number;
+    trailer?: string;
+    maxCreated?: number;
+    modified: number;
+    added: number;
+    posterv: number;
+    backgroundv: number;
+    cardv: number;
 }
 export interface IEpisode {
     id?: string;
@@ -177,10 +199,39 @@ export interface IEpisode {
         background?: string;
     };
 }
+export type MovieStatus = 'returning' | 'released' | 'inProduction' | 'postProduction' | 'planned' | 'rumored' | 'canceled' | 'unknown' | {
+    other: string;
+};
 export interface IMovie {
-    id?: string;
+    id: string;
     name: string;
+    type?: any;
     year?: number;
+    airdate?: number;
+    digitalairdate?: number;
+    duration?: number;
+    overview?: string;
+    country?: string;
+    status?: MovieStatus;
+    imdb?: string;
+    slug?: string;
+    tmdb?: number;
+    trakt?: number;
+    otherids?: string;
+    lang?: string;
+    original?: string;
+    imdbRating?: number;
+    imdbVotes?: number;
+    traktRating?: number;
+    traktVotes?: number;
+    trailer?: RsLink;
+    modified: number;
+    added: number;
+    watched?: number;
+    progress?: number;
+    posterv: number;
+    backgroundv: number;
+    cardv: number;
 }
 export interface IServer {
     id: string;
@@ -324,6 +375,15 @@ export declare enum SqlOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
+export declare enum RsSort {
+    Modified = "modified",
+    Added = "added",
+    Created = "created",
+    Rating = "rating",
+    Name = "name",
+    Size = "size"
+}
+export type MovieSort = 'modified' | 'added' | 'created' | 'name' | 'digitalairdate';
 export interface DeletedQuery {
     after?: number;
     kind?: ElementType;

package/dist/interfaces.js

@@ -53,3 +53,12 @@ export var SqlOrder;
     SqlOrder["ASC"] = "ASC";
     SqlOrder["DESC"] = "DESC";
 })(SqlOrder || (SqlOrder = {}));
+export var RsSort;
+(function (RsSort) {
+    RsSort["Modified"] = "modified";
+    RsSort["Added"] = "added";
+    RsSort["Created"] = "created";
+    RsSort["Rating"] = "rating";
+    RsSort["Name"] = "name";
+    RsSort["Size"] = "size";
+})(RsSort || (RsSort = {}));

package/dist/library.d.ts

@@ -1,4 +1,4 @@
-import { IFile, ITag, IPerson, ISerie, IMovie, MediaRequest, IEpisode, ExternalImage, IBackupFile, ILibrary, SerieInMedia, DeletedQuery, RsDeleted } from './interfaces.js';
+import { IFile, ITag, IPerson, ISerie, IMovie, MediaRequest, IEpisode, ExternalImage, IBackupFile, ILibrary, SerieInMedia, DeletedQuery, RsDeleted, MovieSort, RsSort, SqlOrder } from './interfaces.js';
 import { EncryptFileOptions, EncryptedFile } from './encryption.js';
 export interface MediaForUpdate {
     name?: string;
@@ -92,8 +92,19 @@ export declare class LibraryApi {
         name?: string;
         after?: number;
     }): Promise<IPerson[]>;
-    getSeries(): Promise<ISerie[]>;
-    getMovies(): Promise<IMovie[]>;
+    getSeries(query?: {
+        after?: number;
+        name?: string;
+        watched?: boolean;
+        sort?: RsSort;
+        order?: SqlOrder;
+    }): Promise<ISerie[]>;
+    getMovies(query?: {
+        after?: number;
+        inDigital?: boolean;
+        watched?: boolean;
+        sort?: MovieSort;
+    }): Promise<IMovie[]>;
     getMedias(filter?: MediaRequest): Promise<IFile[]>;
     countMedias(filter?: MediaRequest): Promise<{
         count: number;

package/dist/library.js

@@ -95,14 +95,46 @@ export class LibraryApi {
         const res = await this.client.get(this.getUrl('/people'), { params });
         return res.data;
     }
-    async getSeries() {
-        const res = await this.client.get(this.getUrl('/series'), {
-            params: { sort: 'name', order: 'ASC' }
-        });
+    async getSeries(query) {
+        const params = {};
+        if (query) {
+            if (query.after !== undefined) {
+                params.after = query.after;
+            }
+            if (query.name !== undefined) {
+                params.name = query.name;
+            }
+            if (query.watched !== undefined) {
+                params.watched = query.watched;
+            }
+            if (query.sort !== undefined) {
+                params.sort = query.sort;
+            }
+            if (query.order !== undefined) {
+                params.order = query.order;
+            }
+        }
+        // Defaults { sort: 'name', order: 'ASC' } have been removed
+        const res = await this.client.get(this.getUrl('/series'), { params });
         return res.data;
     }
-    async getMovies() {
-        const res = await this.client.get(this.getUrl('/movies'));
+    async getMovies(query) {
+        const params = {};
+        if (query) {
+            if (query.after !== undefined) {
+                params.after = query.after;
+            }
+            if (query.inDigital !== undefined) {
+                params.inDigital = query.inDigital;
+            }
+            if (query.watched !== undefined) {
+                params.watched = query.watched;
+            }
+            if (query.sort !== undefined) {
+                params.sort = query.sort;
+            }
+        }
+        const res = await this.client.get(this.getUrl('/movies'), { params });
         return res.data;
     }
     async getMedias(filter) {

package/libraries.md

@@ -360,16 +360,33 @@ await libraryApi.updatePersonPortrait('person-id', formData);
 
 ## Series
 
-### `getSeries(): Promise<ISerie[]>`
+### `getSeries(query?: { after?: number; name?: string; watched?: boolean; sort?: RsSort; order?: 'ASC' | 'DESC' }): Promise<ISerie[]>`
 
-Retrieves all series in the library, sorted by name.
+Retrieves series in the library with optional filtering.
+
+**Parameters:**
+- `query`: Optional query object with filtering parameters:
+  - `after`: Filter series modified after this timestamp (integer unix milliseconds)
+  - `name`: Filter series by name
+  - `watched`: Filter by watched status
+  - `sort`: Sort key using `RsSort` enum (`Modified`, `Added`, `Created`, `Rating`, `Name`, `Size`)
+  - `order`: Sort direction (`'ASC'` or `'DESC'`)
 
 **Returns:** Promise resolving to an array of `ISerie` objects
 
 **Example:**
 ```typescript
+// Get all series
 const series = await libraryApi.getSeries();
-```
+
+// Get series with filters and sorting
+const filteredSeries = await libraryApi.getSeries({
+    watched: false,
+    sort: RsSort.Rating,
+    order: 'DESC',
+    after: Date.now() - 86400000 // Last 24 hours
+});
+
 
 ### `createSerie(serie: Partial<ISerie>): Promise<ISerie>`
 
@@ -581,16 +598,30 @@ await libraryApi.setEpisodeWatched('serie-id', 1, 1, Date.now());
 
 ## Movies
 
-### `getMovies(): Promise<IMovie[]>`
+### `getMovies(query?: { after?: number; inDigital?: boolean; watched?: boolean; sort?: MovieSort }): Promise<IMovie[]>`
 
-Retrieves all movies in the library.
+Retrieves movies in the library with optional filtering.
+
+**Parameters:**
+- `query`: Optional query object with filtering parameters:
+  - `after`: Filter movies modified after this timestamp (integer unix milliseconds)
+  - `inDigital`: Filter by digital release availability
+  - `watched`: Filter by watched status
+  - `sort`: Sort key (`'modified'`, `'added'`, `'created'`, `'name'`, or `'digitalairdate'`)
 
 **Returns:** Promise resolving to an array of `IMovie` objects
 
 **Example:**
 ```typescript
+// Get all movies
 const movies = await libraryApi.getMovies();
-```
+
+// Get movies with filters
+const filteredMovies = await libraryApi.getMovies({
+    inDigital: true,
+    sort: 'digitalairdate',
+    after: Date.now() - 86400000 // Last 24 hours
+});
 
 ### `createMovie(movie: Partial<IMovie>): Promise<IMovie>`
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@redseat/api",
-    "version": "0.0.16",
+    "version": "0.0.18",
     "description": "TypeScript API client library for interacting with Redseat servers",
     "type": "module",
     "main": "./dist/index.js",